Get Weekly Usage
Returns the number of calls consumed in the past 7 days.
Responses
200 OK ResponseOfUsageData
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
moreResult boolean Boolean indicating if there are more results in subsequent pages
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of UsageData required
Array of results for individual records in the operation, may be empty
Model UsageData
date string (date-time) required Date of the collected calls
total integer (int32) Total number of calls in the time period
users array of UserCount
Counts for individual users
Model UserCount
count integer (int32) required Number of calls made in the time period
userId string required Id of the user
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"moreResult": false,
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"date": "2026-01-15T10:30:00Z",
"total": 123,
"users": [
{
"count": 123,
"userId": "person@example.com"
}
]
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.