PApax8
Usage Summaries

List Usage Summaries

Fetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200

get/subscriptions/{subscriptionId}/usage-summaries

Request

  • Base URL
    https://api.pax8.com/v1
  • URL
    https://api.pax8.com/v1/subscriptions/{subscriptionId}/usage-summaries
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://token-manager.pax8.com/oauth/token

Path parameters

subscriptionIdstring uuid required
Example:04814f37-bef0-48b7-b388-c04a1e31f889

Query parameters

pagenumber

The page number to request in the usage summaries list

sizenumber

Returns this number of usage summaries per page

sort'resourceGroup,asc' | 'resourceGroup,desc'

Return usage summaries sorted by this field and direction. Formatted as fieldName,direction - ex. sort=resourceGroup,desc

resourceGroupstring
Example:IronCloud Technologies

Return only usage summaries matching this resourceGroup value

companyIdstring uuid
Example:f7fc273a-8d86-45c9-a26f-ffd42416adda

Return only usage summaries with this companyId value

Response

Successful operation

Example response

{
  "page": {
    "size": 50,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.