Retrieve usage csv by billing tag
- Last UpdatedApr 15, 2025
- 2 minute read
This tutorial gets the usage in CSV format, using the billing tag.
This sample request uses org123456789 as the realmId, 2021-07-01T10:39:51 as the startDate, 2021-08-30T10:39:51 as the endDate, and testtag as the billingTag.
Parameters
The parameters shown here are only those required for this sample request. For a complete list of parameters, see the Cost Management Usage API v2 API Reference.
| realmId required | string [ 5 ... 30 ] characters. Example: org123456789 Your org ID. |
|---|---|
| startDate required |
string "date-time". Example: startDate=yyyy-MM-dd'T'HH:mm:ss Start date for a search. |
| endDate required |
string "date-time". Example: endDate=yyyy-MM-dd'T'HH:mm:ss End date for a search. |
| billingTag | string less than or equal to 500 characters. Example: billingTag=testtag Billing tags can combine costs on your invoices. |
Header parameters
| X-Request-ID | string User-provided token used to trace a request or a group of requests sent to the service. |
|---|---|
| X-Correlation-ID required |
string Auto-generated ID, which uniquely identifies the request, available in the response. When contacting the support team with an inquiry regarding a specific request, provide the value of this header. This helps when troubleshooting the issue. |
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, which is billable. - 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. 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 billable rate per unit.
- Total Price: The calculated cost of your usage.
For partners, there is an additional column in the CSV output. The additional column is the name of the organization, orgName.
