Skip to navigation
Customer

get usage

Get usage for the authenticated account over a time period. GroundX selects its subscription and usage meter; do not supply their IDs or a customer ID. startTime is inclusive and endTime is exclusive. Both must be RFC3339 timestamps on minute boundaries and are converted to UTC. endTime cannot be in the future. The window cannot exceed 366 days. usageAsOf identifies the latest usage summary available to GroundX.

Authentication

X-API-Keystring
API Key authentication via header

Query parameters

metricenumRequired
Supported usage metric to query.
Allowed values:
startTimestringRequiredformat: "date-time"
Inclusive RFC3339 window start. Must be aligned to a minute boundary.
endTimestringRequiredformat: "date-time"
Exclusive RFC3339 window end. Must be aligned to a minute boundary and cannot be in the future.

Response

Usage query success
customerobject

Errors

400
Bad Request Error
404
Not Found Error