Get usage by organization

The Usage API allows you to query usage for your organization(s), which uses a realmId for each organization. You can retrieve your organization's usage by using your realmId, as shown here.

Request

This example uses org123456789 as the realmId.

Parameters

realmId required string [ 5 .. 30 ] characters
Example: org123456789
Your org ID.
startTime
required
string
Example: startTime=yyyy-MM-dd'T'HH:mm:ss
Start date for history search.
endTime
required
string
Example: endTime=yyyy-MM-dd'T'HH:mm:ss
End date for history search.
featureId string less than or equal to 256 characters
Example: featureId=hrn:here:service::org123456789:search-geocoding-1
Feature HRN.
appId string less than or equal to 128 characters
Example: appId=j1dasda012edasfgne
Client application ID. This is the application ID which was created in the platform.
channelId string
Enum: "hot" "cold"
Example: channelId=cold
When this parameter is provided, the results are filtered by the ID identifying the channel for the usage reporting.
projectHrn string less than or equal to 256 characters
Example: projectHrn=hrn:here:authorization::myrealm:project/my-project-0000
The HRN which identifies the project.
billingTag string less than or equal to 500 characters
Example: billingTag=testtag
The billingTag.
category string less than or equal to 128 characters
Example: category=Pipelines
The category.
limit integer [ 1 .. 100 ]
Example: category=Pipelines
Default: 100
Number of records to return. The default and maximum is 100 records.
offset integer >= 0
Example: offset=1
Default: 0
Offset page number. The default value is 0.
detailLevel string
Enum: "summarized" "hour" "day" "month"
Example: detailLevel=hour
Default: 0
This query parameter controls granularity of records at the levels of summarized, hour, day, or month. By default, detailLevel is set to summarized, which means the granularity is at the search criteria level. The usageDateTime field value is not present if detailLevel is set to summarized.
groupBy string less than or equal to 256 characters
Example: groupBy=appId, billingTag, project, resource, usageTypeCode
Comma seperated list of groupBy. Supported values are project, billingTag, usageTypeCode, and appId. The default groupBy is featureId and subscription ID. The groupBy query parameter controls the additional dimensions included in a response. By default, usage records are grouped by featureId (charge Item) and subscription ID, which means that the only dimensions included are featureId and subscription ID. When additional groupBy are added through the query parameter, it is in addition to featureId and subscription ID.
usageFields Array of strings unique
Items Enum: "realmId" "featureId" "billingSubscriptionId" "billingChargeNumber" "category" "name" "valueDriver" "usageValue" "billableValue"
Example: usageFields=realmId,featureId,category
A set of unique/distinct usage field names which are allowed to filter response objects properties.

Header parameters

X-Request-ID string
User-provided token that can be used to trace a request or a group of requests sent to the service.
X-Correlation-ID
required
string
Auto-generated ID, which uniquely identifies the request, available in the response. When contacting the support with an inquiry regarding a specific request, provide the value of this header; This will help troubleshooting the issue.
    GET https://usage.bam.dev.api.here.com/v2/usage/realms/{realmId}

Response: HTTP 200 OK

{
    "total": 10,
    "limit": 2,
    "items":[
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-00011212",
      "category": "service",
      "name": "Geocoder Autosuggest",
      "valueDriver": "Transactions",
      "usageValue": "10",
      "billableValue": "10"
    },
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-0001124",
      "category": "service",
      "name": "Lane attributes",
      "valueDriver": "GB",
      "usageValue": "10",
      "billableValue": "10"
    }
  ], 
    "nextOffset": 1,
    "lastOffset": 4
}

results matching ""

    No results matching ""