---
title: "Get Global Usage Report v2.0"
method: POST
path: "/msp/reporting/v3/reports/mspGlobalUsage"
tags: ["Reports"]
---

# Get Global Usage Report v2.0

`POST /msp/reporting/v3/reports/mspGlobalUsage`

Returns a detailed report on consumption units usage across all customers and products.

## Headers

- `Authorization` string, required

## Request body

- GetGlobalUsageRequestV3 — Specify the details required to retrieve the global usage report.
  - `pageToken` string — The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'. - Keep this field blank in the first request.
  - `filters` FilterTypeForGlobalUsageV3
    - `pageSize` integer — Specify the maximum number of records that should returned in a response. The default page size is 100 records. The maximum limit is 500 records. :fa-info-circle: If you specify the pageSize, value from the first API call will be used for the subsequent calls, even if you change the pageSize later on.
    - `filterBy` FilterAttributeForGlobalUsageV3[] — Filters if needs to be applied.
      - `fieldName` 'accountName' | 'cuConsumption' | 'customerName' | 'edition' | 'mspGlobalId' | 'mspName' | 'productModule' | 'servicePlan' | 'tenantType' — Specify the name of the filter attribute.
      - `value` string — Specify value of column that needs to be filtered. For CONTAINS operator - this can be array of either int or string. For other operators, depending on the datatype of fieldName attribute this can be either int / string / RFC3339 date format. This is case sensitive.
      - `operator` 'EQUAL' | 'NOTEQUAL' | 'CONTAINS' | 'LT' | 'GT' | 'LTE' | 'GTE' — Operator for specified filters. All string comparisons will be case sensitive. Supported filters are: - EQUAL: This will return the data with exact match for given field name. - NOTEQUAL: This will return the data not matching with given values. - CONTAINS: Value for this operator will be an array. This will return data which matches with any value mentioned in array. - LT: This is the 'LESS THAN' comparison operator. - LTE: This is the 'LESS THAN OR EQUAL TO' comparison operator. - GT: This is the 'GREATER THAN' comparison operator. - GTE: This is the 'GREATER THAN OR EQUAL TO' comparison operator. For a particular field name an operator can be used once at max. For columns having string data type 'LT', 'LTE', 'GT', 'GTE' operators will work lexicographically.

## Response `200`

Ok

- GetGlobalUsageResponseV3
  - `data` GlobalUsageItemV3[] — The list contains global usage details about consumption units usage across all customers and products. Includes mspGlobalId and mspName for parent-child hierarchy visibility.
    - `accountName` string — Account name defined for the customer
    - `cuConsumption` number, double — The consumption units consumed.
    - `customerName` string — Customer name defined for the customer
    - `dcpUniqueKey` string — The unique key identifier of the record.
    - `edition` string — The product edition.
    - `mspGlobalId` string — The global ID of the Managed Service Provider (MSP).
    - `mspName` string — The organization name of the Managed Service Provider (MSP).
    - `productModule` string — The name of the product module.
    - `servicePlan` string — The name of the service plan.
    - `tenantType` string — The type of tenant (Commercial/Evaluation).
  - `filters` object — All filters passed in request are returned in response.
    - `pageSize` integer — Maximum number of records that can be returned in the response.
    - `filterBy` FilterAttributeForGlobalUsage[] — Filters applied in the request.
      - `fieldName` 'accountName' | 'cuConsumption' | 'customerName' | 'edition' | 'productModule' | 'servicePlan' | 'tenantType' — Specify the name of the filter attribute.
      - `value` string — Specify value of column that needs to be filtered. For CONTAINS operator - this can be array of either int or string. For other operators, depending on the datatype of fieldName attribute this can be either int / string / RFC3339 date format. This is case sensitive.
      - `operator` 'EQUAL' | 'NOTEQUAL' | 'CONTAINS' | 'LT' | 'GT' | 'LTE' | 'GTE' — Operator for specified filters. All string comparisons will be case sensitive. Supported filters are: - EQUAL: This will return the data with exact match for given field name. - NOTEQUAL: This will return the data not matching with given values. - CONTAINS: Value for this operator will be an array. This will return data which matches with any value mentioned in array. - LT: This is the 'LESS THAN' comparison operator. - LTE: This is the 'LESS THAN OR EQUAL TO' comparison operator. - GT: This is the 'GREATER THAN' comparison operator. - GTE: This is the 'GREATER THAN OR EQUAL TO' comparison operator. For a particular field name an operator can be used once at max. For columns having string data type 'LT', 'LTE', 'GT', 'GTE' operators will work lexicographically.
  - `lastSyncTimestamp` string, date-time — Last time sync up timestamp date. Sync up time does not guarantee that consumption stats till this time are included in reported stats. Reported consumption stats may be stale upto 48 hours.
  - `nextPageToken` string — The token to access the next page of results. This parameter will be empty for the last page of results.

## Other responses

- `400` — Bad Request
- `401` — The request did not include an authentication token or an expired authentication token was supplied.
- `500` — The request was not processed due to an internal error.

---

[API](https://skmtc.net/druva/apis/authentication.md) · [All operations](https://skmtc.net/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/druva/authentication/versions/2af2bf148b25/schema)