---
title: "View Users Count & Status Report"
method: POST
path: "/msp/reporting/v1/reports/mspM365UserCountAndStatus"
tags: ["Microsoft 365 Reports"]
---

# View Users Count & Status Report

`POST /msp/reporting/v1/reports/mspM365UserCountAndStatus`

View the weekly and monthly count of users added, preserved, and deleted for a specified period. 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` 'accountName' | 'customerName' | 'customerGlobalId' | 'period' | 'startDate' | 'endDate' | 'totalUsers' | 'totalPreservedUsers' | 'userAdded' | 'usersDeleted' | 'usersPreserved' — 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

- GetM365UserCountAndStatusReportDataResponse
  - `data` M365UserCountAndStatusReportData[]
    - `accountName` string — Account name defined for the customer
    - `customerName` string — Customer name defined for the customer
    - `customerGlobalId` string — Unique ID of the customer.
    - `period` string — Records are categorized by duration: week or month. User count variations are segmented based on these periods.
    - `startDate` string, date-time — The start date of the specified week or month.
    - `endDate` string, date-time — The end date of the specified week or month.
    - `totalUsers` integer — The total number of active users allocated within the specified period.
    - `totalPreservedUsers` integer — The total number of preserved users allocated within the specified period.
    - `userAdded` integer — The number of users added within the specified period.
    - `usersDeleted` integer — The number of users deleted within the specified period.
    - `usersPreserved` integer — The number of users marked as preserved within the specified period.
  - `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)