WorkspaceWorkspaceUsage

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.

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_secondsintegerOptional>=1Defaults to 60

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_bylist of enums or nullOptional
filterslist of objects or nullOptional
time_zonestringOptionalDefaults to UTC

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
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