v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB
InboxesMetrics

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.

get/v0/inboxes/{inbox_id}/metrics/usage

Path parameters

inbox_idstring required

The ID of the inbox.

Query parameters

usage_typesUsageType[]

List of usage metric types to query. Omit to query every type valid for the scope.

startstring date-time

Start timestamp for the query.

endstring date-time

End timestamp for the query.

periodinteger

Size of each time bucket as a whole number of seconds, between 1 and 86400.

limitinteger

Limit on number of buckets to return.

descendingboolean

Sort in descending order.

Response

QueryUsageResponse required

Cumulative usage series grouped by usage type.