Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Reports

Get Itemized Tenant Quota Report v2.0

Returns a detailed daily report on MSP tenant quota usage based on the currently active quota. If no active quota exists, the report uses the last active quota. Quotas set to 0 are excluded.

post/msp/reporting/v3/reports/quotaItemized

Headers

Authorizationstring required

Specify the Bearer access token

Request body

pageTokenstring

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.

Example request

{
  "pageToken": "eyJwYWdlTnVtYmVyIjoyLCJwYWdlU2l6ZSI6NTAwLCAiZmlsdGVycyI6bnVsbH0=",
  "filters": {
    "pageSize": 10,
    "filterBy": [
      {
        "fieldName": "customerGlobalId",
        "value": "b825cee3-5780-45ca-bc1d-83a9ccec5d7b",
        "operator": "EQUAL"
      }
    ]
  }
}

Response

Ok

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of results.

lastSyncTimestampstring date

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.

Example response

{
  "data": [
    {
      "customerGlobalId": "bde7f8c2-d063-4a4a-9a8f-c2ea5aff42f3-198",
      "mspGlobalId": "MSP:968cf837-0e5e-4645-a510-82b8d4b9e98d",
      "mspName": "Example MSP Organization",
      "accountName": "Example customer",
      "tenantId": "0001f138-0c37-4980-b3f2-a3342f201ba3",
      "productId": 1,
      "productName": "Enterprise Workloads",
      "productModuleId": 1,
      "productModuleName": "Enterprise Workloads",
      "editionName": "Business",
      "tenantType": "Commercial",
      "date": "2022-01-11T00:00:00.000Z",
      "servicePlanId": 1,
      "servicePlanName": "Example service plan",
      "usageDescription": "Accelerated Ransomware Recovery",
      "usageAmount": 1,
      "usageUnit": "Bytes",
      "cuConsumed": 1.5,
      "dcpUniqueKey": "380cee0972ed3f2286c03749ffc235d0cc52250121c2d3fac6c6b4f0b14d7875"
    }
  ],
  "nextPageToken": "eyJwYWdlTnVtYmVyIjoyLCJwYWdlU2l6ZSI6NTAwLCAiZmlsdGVycyI6bnVsbH0=",
  "filters": {
    "pageSize": 10,
    "filterBy": [
      {
        "fieldName": "customerGlobalId",
        "value": "b825cee3-5780-45ca-bc1d-83a9ccec5d7b",
        "operator": "EQUAL"
      }
    ]
  },
  "lastSyncTimestamp": "2023-01-11T00:00:00.000Z"
}