Skip to main content

Get Consumptions

GET /v2/consumption

List consumption in a simplified, period-aggregated format: one value per property for the requested range. Same tenant rules as V1 (tenant validation and tenant tree). Supports filter (tenant, target), aggregation (min, max, avg), and granularity. startDate and endDate (ISO 8601) are required.

Aggregation defines how multiple values within each time bucket are combined: min (lowest), max (highest), or avg (average). Use max for capacity or peak usage (e.g. protected data, targets); use avg for typical usage; use min when you need the floor. Defaults to max.

Granularity controls the time bucket: hour, day, week, month, year, or period. Use period for a single aggregated value per property over the whole range (typical for V2); use finer granularities for time-series breakdowns.

Query Parameters​

  • ~filter[tenant] - Parameter for ~filter[tenant]
  • ~filter[target] - Parameter for ~filter[target]
  • ~aggregation - Parameter for ~aggregation
  • ~granularity - Parameter for ~granularity
  • startDate - Parameter for startDate
  • endDate - Parameter for endDate

Request Example​

GET /v2/consumption

Example Query Parameters​

filter[tenant]=6243089747d40e7229c9e071
filter[target]=5035aa2950051155929e6d44
aggregation=max
granularity=period
startDate=2024-02-01T00:00:00.000Z
endDate=2024-02-29T23:59:59.999Z

Response Example​

[
  { "name": "protected_data", "value": 328530971886 },
  { "name": "targets", "value": 11 },
  { "name": "count_jobs", "value": 9329 },
  { "name": "vulnerabilities", "value": 0 },
  { "name": "licenced_users", "value": 19 },
  { "name": "licenced_data", "value": 151052474975.58 }
]