Consumption
Get detailed Consumption data
Returns the consumption of your organization over a specified period.
get/consumptions/detail
Query parameters
afterstring
After cursor (pagination)
limitinteger
The limit of items count to retrieve.
fromstring date required
Example:2022-12-10
The starting date for data retrieval.
tostring date required
Example:2022-12-10
The end date for data retrieval. The to date must be later than the from date and within one year of the from date.
breakdown_type'organization' | 'workspace'
Specifies how data is grouped. By default, it returns the total consumption for the entire organization. If set to workspace, the data will be grouped by Workspace.
workspace_idsUUID[]
A list of Workspace IDs to filter the results.
[ "9a93d3b5-fb3b-4abf-9e70-26315b33506c" ]
Response
Return the detailed consumption.
Example response
{
"meta": {
"updated_at": "2024-01-18T22:59:00Z"
},
"data": [
{
"workspace_id": "8b6ed2f3-244f-487a-baa1-bbe4f51c8744"
}
]
}