Get usage by appId

This tutorial explains how to get your usage by using the appId

Note

Usage alerts based on an appId are only available for location services.

You can use the appId to retrieve your usage amount, using the following request.

Request

This example uses org123456789 as the realmId and j1dasda012edasfgne as the appId.

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&appId=j1dasda012edasfgne

Parameters

The parameters shown here are necessary for this request. For a complete list of parameters, see the Tutorials overview.

realmId required string [ 5 .. 30 ] characters
Example: org123456789
Your org ID.
startDate
required 		string
Example: startDate=yyyy-MM-dd'T'HH:mm:ss
Start date for period.
endDate
required 		string
Example: endDate=yyyy-MM-dd'T'HH:mm:ss
End date for usage period.
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.

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.

Response: HTTP 200 OK

{
"total": 1,
"limit": 100,
"items": [
{
“appId”: “j1dasda012edasfgne”,
"realmId": "org123456789",
"billingSubscriptionId": "",
"billingChargeNumber": "",
"featureId": "hrn:here-dev:service::org123456789:routing-8:import",
"category": "LocationServices",
"name": "Route Import",
"valueDriver": "GB",
"usageTypeCode": "OLS-G-Route-Import",
"usageValue": 10.0000,
"billableValue": 10.0000
}
],
"nextOffset": 0,
"lastOffset": 0
}

More information can be found in the Usage API Reference.

results matching ""

    No results matching ""