List resources
This request is used to retrieve the resource consumption of the given user id including all subaccounts. Important thing about this request: usage is returned only if product is assigned to the account directly and not available to subaccounts.
There's a special header though: 'x-total-usage'. Setting the value of it to "true" forces the API to return total usage of all accounts which belong to current product assignment.
There will be a resource record for every resource that exists on the currently valid configuration of the product that this user is using.
However, we may not always have a utilisation record for a resource. For example, on a fresh account with no backups, we may not have any data history yet. In that case, the 'evaluated' element will be missing (telling us that consumption was simply not evaluated for this resource).
Usually, though, both limit, usage and violated elements will be present along with the evaluated element.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Headers
X-Total-UsageIf true, returns total usage across all accounts in the current product assignment, including subaccounts.
List resources › Responses
Get momentary consumption
Returns a summary of current resource consumption across the account and its children. Provides human-readable resource names grouped by connector type with usage counts.
Resource names in this response are human-readable display names (e.g. "Microsoft 365 Full", "Entra ID"), not the property keys used in other endpoints (e.g. o365-admin, azure-ad).
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get momentary consumption › Responses
Get resource usage
Returns current resource usage filtered by criteria. Uses PUT with an XML filter body (not GET) — the filter criteria are sent in the request body.
This endpoint uses PUT (not GET) because it requires an XML filter body. The response returns filtered resource usage, or an empty <resources/> element if no matches.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get resource usage › Responses
Get resource history
Returns historical resource usage over a date range. Uses PUT with an XML filter body including date range (not GET).
This endpoint uses PUT (not GET) because it requires an XML filter body with the date range and filter criteria.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get resource history › Responses
Get device resources
Returns resources for a specific connector (device) within the account.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).