---
title: "View License Usage Report"
method: POST
path: "/msp/reporting/v1/reports/mspEPLicenseUsage"
tags: ["Endpoints Reports"]
---

# View License Usage Report

`POST /msp/reporting/v1/reports/mspEPLicenseUsage`

This report provides details of total users added and deleted, total Endpoints active and preserve licenses allocated for MSP customers. This API may be updated without any prior notification. Check the API documentation for the latest updates regularly.

## Headers

- `Authorization` string, required

## Request body

- object
  - `filters` object
    - `pageSize` integer — Specify the maximum number of records that should returned in a response. Maximum limit is 500 records. Default pageSize is 100.
    - `filterBy` object[] — Select the filters to be applied to the report.
      - `fieldName` 'customerGlobalId' | 'accountName' | 'customerName' | 'fromDate' | 'toDate' | 'usersAdded' | 'usersDeleted' | 'totalActiveLicense' | 'activeLicenseUsed' | 'totalPreservedLicense' | 'preservedLicenseUsed' — Specify the name of the filter.
      - `operator` 'EQUAL' | 'GT' | 'GTE' | 'LT' | 'LTE' | 'CONTAINS' | 'NOTEQUAL' — The operators that are supported for the filter are - EQUAL, NOTEQUAL, CONTAINS, LT (less-than), LTEQ (less-than-or-equal), GT (greater-than), GTEQ (greater-than-or-equal).
      - `value` union — Specify the value of the filter applied to the report.
        - string — string
        - integer — integer
        - string[] — array of strings
        - integer[] — array of integers
  - `pageToken` string — Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.

## Response `200`

Success

- GetLicenseUsageReportDataResponse
  - `data` LicenseUsageReportData[]
    - `customerGlobalId` string — Unique ID of the customer.
    - `accountName` string — Account name defined for the customer
    - `customerName` string — Customer name defined for the customer
    - `fromDate` string, date-time — For Weekly report- The start date of the weekly report. For the Monthly report- The start date of the monthly report. The time is in the UTC time zone. Example- 2019-10-25T00:00:00Z00:00
    - `toDate` string, date-time — For Weekly report- The end date of the weekly report. For the Monthly report- The end date of the monthly report. The time is in the UTC time zone. Example- 2019-10-25T00:00:00Z00:00
    - `usersAdded` integer — For Weekly report- The total number of users added for a given week. For the Monthly report- The total number of users added to Endpoints for a given month.
    - `usersDeleted` integer — For Weekly report- The total number of users deleted for a given week. For the Monthly report- The total number of users deleted from Endpoints for a given month.
    - `totalActiveLicense` integer — For Weekly report- The total number of Endpoints active licenses that are allocated in Endpoints to date for a given week. For the Monthly report- The total number of Endpoints active licenses that are allocated in Endpoints to date for a given month.
    - `activeLicenseUsed` integer — For Weekly report- The total number of Endpoints active licenses that are consumed in Endpoints to date for a given week. For the Monthly report- The total number of Endpoints active licenses that are consumed in Endpoints to date for a given month.
    - `totalPreservedLicense` integer — For Weekly report- The total number of Endpoints preserved licenses that are allocated in Endpoints to date for a given week. For the Monthly report- The total number of Endpoints preserved licenses that are allocated in Endpoints to date for a given month.
    - `preservedLicenseUsed` integer — For Weekly report- The total number of Endpoints preserved licenses that are consumed in Endpoints to date for a given week. For the Monthly report- The total number of Endpoints preserved licenses that are consumed in Endpoints to date for a given month.
  - `lastSyncTimestamp` string, date-time — The time stamp until which the report data was returned. The time is in the UTC time zone.
  - `filters` object — Filters applied on the report.
  - `nextPageToken` string — The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

## Other responses

- `400` — Bad Request
- `404` — The requested resource was not found.
- `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)
