curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/metering/meters/{meterId} \
--header 'Authorization: Bearer <token>' \
--header 'cdf-version: <cdf-version>'{
"meterId": "atlas.monthly_ai_tokens",
"datapoints": []
}Retrieve consumption data by its id
Required capabilities:
projectsAcl:LIST
Retrieves consumption data by its meterId.
- Without
startandnumberOfDatapoints: Returns meter metadata. - With
startandnumberOfDatapoints: Returns historical time-series data with averaged values.
curl --request GET \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/metering/meters/{meterId} \
--header 'Authorization: Bearer <token>' \
--header 'cdf-version: <cdf-version>'{
"meterId": "atlas.monthly_ai_tokens",
"datapoints": []
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Headers
20230101-alpha Path Parameters
Metering is identified by an id containing the service name and a service-scoped metering name.
For instance atlas.monthly_ai_tokens is the id of the atlas service metering monthly_ai_tokens.
Service and metering names are always in lower_snake_case.
Query Parameters
Start timestamp (inclusive) for historical data, in milliseconds since epoch.
When provided along with end and numberOfDatapoints, returns time-series data.
End timestamp (inclusive) for historical data, in milliseconds since epoch. Defaults to the current time if not provided.
Number of data points to return between start and end.
The time range is divided into equal buckets, and the average value for each bucket is returned.
0 <= x <= 600Response
The requested consumption data. Returns meter metadata unless 'start' and 'numberOfDataPoints' are provided. When they are provided, includes historical time-series data with averaged values.
A singular representation of the current consumption.
Metering is identified by an id containing the service name and a service-scoped metering name.
For instance atlas.monthly_ai_tokens is the id of the atlas service metering monthly_ai_tokens.
Service and metering names are always in lower_snake_case.
Timestamped data points with average values. Empty for list operations, populated when retrieving specific meters.
Show child attributes
Show child attributes
Was this page helpful?