Get usage by projectHrn

You can use the projectHrn to get your usage amount, as shown in this tutorial. To find your project HRN, click the the Projects Manager option in the platform Launcher. A table of project HRNs are then displayed, and you can find the correct project HRN for your request in the list.

Request

This example uses org123456789 as the realmId and hrn:here:authorization::myrealm:project/my-project-0000 as the projectHrn.

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&projectHrn=projectHrn=hrn:here:authorization::myrealm:project/my-project-0000

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 history search.
endDate
required 		string
Example: endDate=yyyy-MM-dd'T'HH:mm:ss
End date for history search.
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.

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": [
{
"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,
“projectHrn”: “hrn:here:authorization:org999029259:project/my-project-000”,
"billableValue": 10.0000
}
],
"nextOffset": 0,
"lastOffset": 0
}{
"total": 1,
"limit": 100,
"items": [
{
"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,
“projectHrn”: “hrn:here:authorization:org999029259:project/my-project-000”,
"billableValue": 10.0000
}
],
"nextOffset": 0,
"lastOffset": 0
}

More information can be found in the Usage API Reference.

results matching ""

    No results matching ""