Usage service

Note

In this document, the term "realm" means "organization". See Manage your organization.

The usage API provides a self-service method of obtaining realm usage data for any services you use on the platform. You can see billable usage for any of your realms, which is how a HERE service measures your licensing terms.

Billing varies by the HERE service. As an example, billing for Location services is measured in transactions, data service storage in GB-Months, and data transfer in GB. Billable usage is calculated per hour.

Note

Usage arrival can take up to 2 hours for Location Services and up to 48 hours for billable cloud services, which means quota rule conditions can take this long to enact.

Get billable usage

  • You can get a snapshot of your platform billable usage information by going to portal launcher > Usage Manager.

  • You can also get billable usage information by accessing the usage API.

  • The Usage API provides billable usage information per realm. You can query additional parameters by appId, projectId, featureId, or billingTag. Billable usage is calculated hourly with a maximum time range of up to 95 days.

Note

Usage by appId and resourceHrn are only supported in Usage API version 2.

Authorization

Your credentials must be generated from the realm where your usage is requested.

Get usage by realm, feature, project, app

The usage API enables you to query usage by realm, feature, project, and app. To access the usage API, you must create an app and credentials. See the OAuth tokens documentation for additional details.

Note

The usage API requires a realmId for each query.

Define time range

    startDate (yyyy-MM-dd'T'HH:mm:ss), for example 2021-07-01T10:39:51
    endDate (yyyy-MM-dd'T'HH:mm:ss), for example 2021-08-30T10:39:51

Define detail level

You can define the granularity of records from your query at summarized, hour, day, or month. By default, detailLevel is summarized, meaning granularity is at the search criteria level.

Available values: summarized, hour, day, month.

Tutorials

For tutorials of how to use the usage service, see Tutorials: Usage service.

results matching ""

    No results matching ""