This section contains a set of developer tutorials to provide an explanation of the Usage API and how to use it to track your HERE platform costs.
The following is a table defining all the possible parameters which can be used in the tutorials for usage requests. Not all parameters are used for all requests, and each tutorial only contains the parameters you can use for that particular request. If a parameter is required, the tutorial shows it as required.
In some of the tutorials, feature HRNs and project HRNs are used to identify specific features and projects you need for filtering usage costs.
On the HERE platform, HERE offered features are identified by their feature ID, which is a feature HERE Resource Name (HRN). Feature HRNs are required to get usage from API requests.
To find your feature HRN, click the Services option in the platform Launcher. 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.
You can use a projectHrn to get your usage amount. To find your project HRN, select 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.
|realmId required ||string [ 5 .. 30 ] characters |
Your org ID.
The start date for a search.
>End date for a search.
|featureId ||string less than or equal to 256 characters |
|appId ||string less than or equal to 128 characters |
Client application ID. This is the application ID which was created in the platform.
|channelId ||string |
Enum: "hot" "cold"
When this parameter is provided, the results are filtered by the ID identifying the channel used for the usage reporting. A cold channel is a new billing data processing pipeline, whereas the hot channel is the old billing data processing pipeline. ChannelId is used for testing purposes.
|projectHrn ||string less than or equal to 256 characters |
The HRN which identifies the project.
|billingTag ||string less than or equal to 500 characters |
Billing tags are used for combining costs on your invoices.
|category ||string less than or equal to 128 characters |
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.
|limit ||integer [ 1 .. 100 ] |
The number of records returned. The default and maximum is 100 records.
|sort ||string |
Enum: "asc" "desc"
Usage report Status to be returned in ascending or descending order of the created date.
|offset ||integer greater than or equal to 0 |
The offset determines the current page number on the search results view.
|detailLevel ||string |
Enum: "summarized" "hour" "day" "month"
You can use this query parameter to select one of the levels of detail to view in your usage records. Levels of detail include: summarized, hour, day, or month. The summarized detail level shows you a summary of your usage and is the default. The usageDateTime field value is not present if detailLevel is set to summarized.
|groupBy ||string less than or equal to 256 characters |
Example: groupBy=appId, billingTag, project
The groupBy parameter is a comma seperated list of parameters which combine as groups. Supported values are project, billingTag, appId, featureId, and subscription ID. The default groupBy parameters are featureId and subscription ID. When groupBy parameters are added in the query, they are added to featureId and subscription ID.
|usageFields ||Array of strings |
realmId: Organization ID.
featureId: Feature HRN.
billingSubscriptionId: The subscription ID for your organization.
billingChargeNumber: Unique charge identifier that maps to corresponding service usage costs. This number is combined with corresponding usage value to compute billable costs.
category: The product category, such as pipelines, data, content, SDKs, and location services.
name: The name of the organization.
valueDriver: The unit of usage value. For example, GB or Transactions.
usageValue: Numerical metric to measure customer usage for a particular service.
billableValue: The amount of billable usage accrued.
resource: All the usage data statistics retrieved and presented to the user.
A set of unique/distinct usage field names which are used to filter responses.