Skip to main content

Get consumptions

GET /v1/consumption

Retrieves a collection of consumptions associated with the authenticated tenant. Each consumption record represents usage data tied to a specific service, application, or user. The endpoint supports filtering and pagination to help manage large datasets efficiently. Returned items include standard attributes such as resource identifiers, timestamps, and usage metrics.

Query Parameters​

  • filter[tenant] - Parameter for filter[tenant]
  • startDate - Parameter for startDate
  • endDate - Parameter for endDate
  • granularity - Parameter for granularity

Request Example​

GET /v1/consumption?filter[tenant]=685498954146b339e63e71b1&startDate=2025-11-01T00:00:00.000Z&endDate=2025-11-17T10:06:20.647Z&granularity=day

Response Example​

[
  {
    "_id": "consumption-id-1",
    "tenant": "tenant-id-1",
    "timestamp": "2025-11-01T00:00:00.000Z",
    "metadata": {
      "service": "backup",
      "application": "exchange"
    },
    "data": {
      "protected_data": 1073741824,
      "targets": 5
    },
    "created": "2025-11-01T00:00:00.000Z",
    "updated": "2025-11-01T00:00:00.000Z"
  },
  {
    "_id": "consumption-id-2",
    "tenant": "tenant-id-1",
    "timestamp": "2025-11-02T00:00:00.000Z",
    "metadata": {
      "service": "backup",
      "application": "sharepoint"
    },
    "data": {
      "protected_data": 2147483648,
      "targets": 3
    },
    "created": "2025-11-02T00:00:00.000Z",
    "updated": "2025-11-02T00:00:00.000Z"
  }
]