Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
access:all

Get Workspace Usage

Returns credit usage broken down by product type over time. The response is a tabular structure with columns, column_types, column_units, and rows.

post/v1/workspace/analytics/query/usage-by-product-over-time

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

start_timeinteger required

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

end_timeinteger required

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

interval_secondsinteger

Bucket size in seconds. Each row in the response covers this many seconds of the selected time range. For example, pass 3600 for hourly buckets or 86400 for daily buckets. Whether time_zone shifts bucket boundaries depends on this value: whole-day multiples (e.g. 86400) align to local midnight; whole-hour multiples up to 24 hours (e.g. 3600, 14400) align to local hour boundaries from midnight; sub-hour values and other sizes remain UTC-anchored regardless of time_zone.

group_bystring[] nullable
time_zonestring

IANA time zone identifier (e.g. 'America/New_York', 'Europe/London', 'UTC') used to align bucket boundaries for eligible interval_seconds values. Whole-day multiples start at local midnight; whole-hour multiples up to 24 hours align to local hour boundaries from midnight. Sub-hour intervals and other bucket sizes remain UTC-anchored regardless of this setting. Defaults to UTC.

Response

Successful Response

columnsstring[] required
column_typesstring[] required
column_unitsColumnUnit[] required