Get consumption index

GET /v1/consumption/index

Retrieves available consumption metrics and their metadata for reporting and billing. The response includes supported filters, dynamic filter keys, field definitions (with data types and tags), valid aggregation operations, time granularity options, and the requested date range.

Query Parameters

• ~filter[tenant] - Parameter for ~filter[tenant]

Request Example

GET /v1/consumption/index

Response Example

{
  "filters": {
    "tenant": "tenant-id-1",
    "application": "example-app",
    "service": "backup",
    "user": "user-id-1",
    "target": "target-id-1"
  },
  "dynamicFilters": [
    "service",
    "application",
    "user",
    "integration",
    "copy_name",
    "plan_group",
    "agentUid",
    "workloadId"
  ],
  "fields": {
    "protected_data": {
      "data_type": "byte",
      "_id": "field-id-1",
      "name": "protected_data",
      "label_name": "Protected data",
      "icon": "dns",
      "color": "#5FBB50",
      "__v": 0,
      "iconColor": "#5FBB50",
      "metadata": {
        "service": ["backup"],
        "application": ["exchange", "sharepoint", "onedrive", "teams", "File", "Cloud Apps / MsTeams", "Cloud Apps / OneDrive", "Exchange Online"]
      }
    },
    "targets": {
      "data_type": "numeric",
      "_id": "field-id-2",
      "name": "targets",
      "label_name": "Targets",
      "icon": "gps_fixed",
      "color": "#90CAFF",
      "__v": 0,
      "iconColor": "#B93BD8",
      "metadata": {
        "application": ["exchange", "sharepoint", "onedrive", "teams", "File", "webapp", "Cloud Apps / MsTeams", "Exchange Online", "Cloud Apps / OneDrive"],
        "service": ["backup", "vulnerability"],
        "user": null
      }
    },
    "count_jobs": {
      "data_type": "numeric",
      "_id": "field-id-3",
      "name": "count_jobs",
      "label_name": "Jobs",
      "__v": 0,
      "iconColor": null,
      "metadata": {
        "service": ["backup"],
        "application": ["exchange", "sharepoint", "onedrive", "teams", "File", "Cloud Apps / OneDrive", "Exchange Online", "Cloud Apps / MsTeams"]
      }
    },
    "vulnerabilities": {
      "data_type": "numeric",
      "_id": "field-id-4",
      "name": "vulnerabilities",
      "label_name": "Vulnerability",
      "__v": 0,
      "iconColor": null,
      "metadata": {
        "application": ["webapp"],
        "service": ["vulnerability"],
        "user": null
      }
    },
    "licensed_users": {
      "data_type": "numeric",
      "_id": "field-id-5",
      "name": "licensed_users",
      "label_name": "Licensed users",
      "icon": "people",
      "color": "#FFC107",
      "__v": 0,
      "iconColor": "#1890FF",
      "metadata": {
        "service": ["backup"],
        "integration": ["commvault"]
      }
    },
    "licensed_data": {
      "data_type": "byte",
      "_id": "field-id-6",
      "name": "licensed_data",
      "label_name": "Licensed data",
      "icon": "dns",
      "color": "#5FBB50",
      "__v": 0,
      "iconColor": "#FFC107",
      "metadata": {}
    },
    "protected_users": {
      "data_type": "numeric",
      "_id": "field-id-7",
      "name": "protected_users",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "application": ["exchange", "sharepoint", "onedrive", "teams", "File"]
      }
    },
    "frontend_size": {
      "data_type": "byte",
      "_id": "field-id-8",
      "name": "frontend_size",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["commvault", "veeam"],
        "copy_name": ["Primary"],
        "plan_group": ["Bronze", "Silver", "Gold"]
      }
    },
    "backend_size": {
      "data_type": "byte",
      "_id": "field-id-9",
      "name": "backend_size",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["commvault", "veeam"],
        "copy_name": ["Primary"],
        "plan_group": ["Bronze", "Silver", "Gold"],
        "application": "VeeamAgent",
        "agentUid": ["agent-uid-1", "agent-uid-2"]
      }
    },
    "workstation-count": {
      "data_type": "numeric",
      "_id": "field-id-10",
      "name": "workstation-count",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "workstation-points": {
      "data_type": "numeric",
      "_id": "field-id-11",
      "name": "workstation-points",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ],
        "agentUid": ["agent-uid-1", "agent-uid-2"],
        "workloadId": "Workstation_VAG_000_5_0_0"
      }
    },
    "total-points": {
      "data_type": "numeric",
      "_id": "field-id-12",
      "name": "total-points",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "server-points": {
      "data_type": "numeric",
      "_id": "field-id-13",
      "name": "server-points",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "server-count": {
      "data_type": "numeric",
      "_id": "field-id-14",
      "name": "server-count",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "cloud-backup-(vm)-count": {
      "data_type": "numeric",
      "_id": "field-id-15",
      "name": "cloud-backup-(vm)-count",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "cloud-backup-(vm)-points": {
      "data_type": "numeric",
      "_id": "field-id-16",
      "name": "cloud-backup-(vm)-points",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["veeam"],
        "application": [
          "VSPC / Standard",
          "VSPC / Enterprise",
          "VSPC / Enterprise Plus",
          "CloudConnect / Standard",
          "CloudConnect / Enterprise",
          "CloudConnect / EnterprisePlus",
          "VeeamAgent",
          "BackupAndReplication / Standard",
          "BackupAndReplication / Enterprise",
          "BackupAndReplication / EnterprisePlus"
        ]
      }
    },
    "restore-points": {
      "data_type": "numeric",
      "_id": "field-id-17",
      "name": "restore-points",
      "label_name": "Restore-points",
      "icon": "lists",
      "color": "#949DB0",
      "iconColor": "#949DB0",
      "__v": 0,
      "metadata": {
        "service": "backup",
        "integration": "veeam",
        "application": "VeeamAgent",
        "agentUid": ["agent-uid-1", "agent-uid-2"]
      }
    },
    "licenced_users": {
      "data_type": "numeric",
      "_id": "field-id-18",
      "name": "licenced_users",
      "__v": 0,
      "metadata": {
        "service": ["backup"],
        "integration": ["commvault"]
      }
    }
  },
  "aggregation": "min | max | avg",
  "granularity": ["hour", "day", "week", "month", "year", "period"],
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-01-31T23:59:59.999Z"
}