Skip to navigation
workspaceUsage

Get Workspace Cost Usage

Returns the cost of the workspace’s usage over time, for workspaces billed by cost. Usage is bucketed by UTC day. The response is a tabular structure with columns, column_types, column_units, and rows, with one row per group and bucket. total_cost is the cost in the workspace’s currency and total_charge_count the billed quantity. Usage can be grouped or filtered by at most two of user_id, hashed_xi_api_key, region, reporting_workspace_id, billing_group_id, product_type, surface and actor, and grouping by two of them requires an eq or in filter on one. model, request_source, fiat_charge_type and fiat_currency can always be added. Some id columns also get a display-name column, such as user_label, appended after the existing columns. Workspaces billed in credits should use /v1/workspace/analytics/query/usage-by-product-over-time.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
start_timeintegerRequired>=1577836800000

Start of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01.

end_timeintegerRequired>=1577836800000

End of the time range as a Unix timestamp in milliseconds. Must be at least 2020-01-01.

interval_secondsintegerRequired>=86400
Bucket size in seconds, in whole UTC days. Pass 86400 for daily buckets or 604800 for weekly buckets, which start on Monday.
group_bylist of enums or nullOptional
filterslist of objects or nullOptional

Response

Successful Response
columnslist of strings
column_typeslist of enums
rowslist of lists of nullable strings or integers or doubles or booleans
column_unitslist of nullable enums

Errors

422
Unprocessable Entity Error