Skip to navigation
API ReferenceInboxesMetrics

Query Usage

Cumulative usage series for the inbox. Each point is the running total of the usage type at that timestamp, not the change within the bucket. Inbox-scoped queries carry storage_bytes, message_count, and thread_count; requested types that don’t apply to the scope are ignored. Defaults to the last 24 hours; start must be within the last 90 days, and a future end is clamped to now. The range divided by period must not exceed 1000 buckets.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

usage_typeslist of enumsOptional
List of usage metric types to query. Omit to query every type valid for the scope.
startdatetimeOptional
Start timestamp for the query.
enddatetimeOptional
End timestamp for the query.
periodintegerOptional
Size of each time bucket as a whole number of seconds, between 1 and 86400.
limitintegerOptional
Limit on number of buckets to return.
descendingbooleanOptional
Sort in descending order.

Response

This endpoint returns a map from enums to lists of objects.

Errors

400
Validation Error