v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Endpoints Reports

View Users Report

This report provides count of users added, deleted, and preserved for a specified period of MSP customers. This API may be updated without any prior notification. Check the API documentation for the latest updates regularly.

post/msp/reporting/v1/reports/mspEPUsers

Headers

Authorizationstring required

Specify the Bearer access token

Request body

pageTokenstring

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.

Example request

{
  "filters": {
    "filterBy": [
      {
        "fieldName": "usersPreserved",
        "operator": "EQUAL"
      }
    ]
  }
}

Response

Success

lastSyncTimestampstring date-time

The time stamp until which the report data was returned. The time is in the UTC time zone.

filtersobject

Filters applied on the report.

nextPageTokenstring

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.

Example response

{
  "data": [
    {
      "customerGlobalId": "bde7f8c2-d063-4a4a-9a8f-c2ea5aff42f3-198",
      "accountName": "Druva",
      "customerName": "Druva",
      "fromDate": "2022-06-03T14:34:11.532Z",
      "toDate": "2023-09-03T14:34:11.532Z",
      "totalUsers": 7,
      "totalPreservedUsers": 3,
      "usersAdded": 10,
      "usersDeleted": 3,
      "usersPreserved": 3
    }
  ],
  "nextPageToken": "YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA="
}