Get Usage Summary By Realm.

get

https://usage.bam.api.here.com/v2/usage/realms/{realmId}/summary

This API retrieves the billable usage summary per realm at a fixed day-level granularity. Additional filters can be added using query parameters to query by app ID, billing subscription ID, project HRN, or billing tag. The principle must be part of the realm requesting usage and the maximum time range that can be queried is 95 days.

This API does not support pagination (no limit/offset), configurable detail level. Day-level granularity is fixed.

Path Params

realmId

string

required

length between 5 and 30

Organization ID.

Query Params

startDate

date-time

required

Start date for search.

endDate

date-time

required

End date for search.

appId

string

length ≤ 128

^[a-zA-Z0-9-_]*$

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

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

projectHrn

string

length ≤ 256

HRN identifying the project.

billingTag

string

length ≤ 500

Use billing tags for combining expenses from your invoices.

Headers

X-Request-ID

string

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

X-Correlation-ID

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

200OK

400Invalid input provided, see error response for details.

401Access is denied due to invalid credentials.

403You do not have permission to perform this action.

404The requested resource was not found, see the error response for details.