Get usage csv by featureId

On the platform, HERE offered features are identified by the feature HRNs, which are identified as the featureId parameter, and are required to get usage in the API requests. You can also use the featureId parameter to filter the results for a specific feature.

To find your feature HRN, click the Launcher on the platform and select the Services option. A web page containing services is then displayed. When you select your service, a web page containing the HRN for the selected service is displayed.

Feature HRN
Figure 1. Feature HRN

You can retrieve the usage in csv format by adding csv to your request, as shown in the sample request.

Request

This example uses org123456789 for the realmId and hrn:here:service::org123456789:search-geocoding-1 as the featureId.

    GET https://usage.bam.api.here.com/v2/usage/realms/org123456789/csv?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&featureId=hrn:here:service::org123456789:search-geocoding-1

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.
featureId string less than or equal to 256 characters
Example: featureId=hrn:here:service::org123456789:search-geocoding-1
Feature HRN.

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, orgName.

More information can be found in the Usage API Reference.

results matching ""

    No results matching ""