Skip to main content

Get Consumption Index

GET /v1/consumption/index

Returns the schema of available consumption fields and how to query them. No tenant validation; useful for discovering filters, granularity options, and field names before querying consumption data.

Response Example

{
"filters": {
"tenant": "id",
"application": "string",
"service": "string",
"user": "id",
"target": "id"
},
"dynamicFilters": ["type", "..."],
"fields": {
"protected_data": { "title": "Protected data", "icon": "dns", "color": "#5FBB50", "data_type": "byte", "metadata": {} },
"targets": { "title": "Targets", "icon": "gps_fixed", "color": "#90CAFF", "data_type": "numeric", "metadata": {} }
},
"aggregation": "min | max | avg",
"granularity": ["hour", "day", "week", "month", "year", "period"],
"startDate": "date",
"endDate": "date"
}