Get usage csv by projectHrn

You can use the projectHrn to get your usage amount, in csv format, as shown in this tutorial. You can find your project HRN in the platform Launcher by selecting the Projects Manager option. 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::myorganization:project/my-project-0000 as the projectHrn.

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789/csv?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&projectHrn=hrn%3Ahere%3Aauthorization%3A%3Amyrealm%3Aproject%2Fmy-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 a search.
endDate
required
string
Example: endDate=yyyy-MM-dd'T'HH:mm:ss
End date for a 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

The response in csv format lists the following columns:

  • Category (category): The category is the name of the service you have selected, such as location services, content, SDKs, data, or pipelines, for which you are billed.
  • Service or Resource Name: The service, such as Navigate SDK, Network Positioning, 3D Buildings.
  • Billing Tag (billingTag): a user defined unique string used for combining costs.
  • Project ID (projectHrn): (Optional) A unique identifier to manage work and resources that can be applied. This is also known as the project HRN.
  • Start date (startDate): The start date of the usage.
  • End date (endDate): The end date of the usage.
  • Usage amount (billableValue): How much billable usage has accrued.
  • Unit (valueDriver): The unit which is billable, for example GB.
  • Rate per Unit: The rate per unit that you are charged.
  • Total Price: The calculated cost of your usage.

For partners, an additional column is added in the csv output. The additional column is the name of the organization, which is the orgName parameter.

More information can be found in the Usage API Reference.

results matching ""

    No results matching ""