Skip to main content

Consumption

Overview

Track and query usage over time. List and create consumption records, manage consumption properties, and retrieve aggregated time-series data for reporting and billing.

Primary Concepts

  • Consumption record: a single measured unit with timestamp, metadata (tenant, service, application), and data (property values).
  • Consumption property: a defined metric (e.g. protected_data, targets) with name, label, data type, and metadata. Properties are added automatically as consumption records containing new property keys are created.
  • Filter: query by metadata fields such as tenant, application, service, user, or target.
  • Aggregation: min, max, or avg for numeric fields over a time window.
  • Granularity: time bucket (hour, day, week, month, year, period) for time-series queries.

Typical Scenarios

Add usage records, fetch time-series aggregates for dashboards, get latest consumption per tenant or target, and discover available properties and filters.

API Versioning

  • Only the latest version of each endpoint is displayed in this documentation.
  • Older versions are not shown but remain available in the API.
  • Always use the latest version shown when building or updating integrations.