GuidesAPI Reference
API Reference

Retrieve usage by organization

get
https://usage.bam.api.here.com/v2/usage/realms/

This API retrieves the billable usage for your organization (realm). The realm ID is your organization ID.

  • Sort API response records alphabetically in ascending order by subscription ID, category, and charge item (name in the response), respectively.
  • The API supports usage by app ID.
Path Params
string
required
length between 5 and 30

Organization ID.

Query Params
date-time
required

Start date for search.

date-time
required

End date for search.

string
length ≤ 256

Identify features by feature HERE Resource Names (HRNs). Feature HRNs are necessary to acquire your usage using API requests.

string
length ≤ 128

Client app ID. This is the app ID created in the platform.

string
enum

When you provide this parameter, 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. Use ChannelId for testing purposes.

Allowed:
string
enum
Defaults to all

When this parameter is provided, the results are filtered by usages of a specific charge type.

Allowed:
string
length ≤ 256

HRN identifying the project.

string
length ≤ 500

Use billing tags for combining expenses from your invoices.

string
length ≤ 128

The category is the name of the billable service you select, such as location services or pipelines.

billingSubscriptionId
array of strings
length between 1 and 20

A comma-separated list of billing subscription IDs, with a minimum of 1 item and a maximum of 20.

billingSubscriptionId
integer
1 to 100
Defaults to 100

Returns the maximum number of records. The default and maximum is 100 records.

integer
≥ 0
Defaults to 0

The offset page number determines the current page number in the search results view. The default value is zero.

string
enum

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 is the default and shows you a summary of your usage.

Allowed:
string
length ≤ 256

The groupBy parameter is a comma seperated list of parameters which you combine to form groups. Supported values are project, billingTag, appId, featureId, and subscription ID. The default groupBy parameters are featureId and subscription ID. When Add groupBy parameters in the query, so that they add to featureId and subscription ID.

usageFields
array of strings

A set of unique and distinct usage field names which filter responses.

Headers
string

User-provided token used to trace a request or a group of requests sent to the service.

string
required

Auto-generated ID, which uniquely identifies the request and is in the response. When contacting the support team with an inquiry regarding a specific request, provide the value of this header to assist with troubleshooting.

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago