How to retrieve usage by appId

This tutorial shows how to get your usage using an 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.

This sample request uses org123456789 as the realmId, 2021-07-01T10:39:51 as the startDate, 2021-08-30T10:39:51 as the endDate, 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 only those required for this sample request. For a complete list of parameters, see the Cost Management Usage API v2 API Reference.


realmId required	string [ 5 ... 30 ] characters. Example: org123456789 Your org ID.
startDate required	string "date-time". Example:startDate=yyyy-MM-dd'T'HH:mm:ss Start date for period.
endDate required	string "date-time". 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 app ID. This is the app ID which the platform created.

Header parameters


X-Request-ID	string User-provided token 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 team with an inquiry regarding a specific request, provide the value of this header. This helps when troubleshooting the issue.

Response: HTTP 200 OK

The request returns the following sample response:

{
"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
}