Skip to content

Get Mailbox Breakdown

GET
/provider-domains/stats/mailbox-breakdown

The capacity-weighted partition of live mailboxes: allocation, sender, health, tag, blocklist, sequence, capacity.

Allocation precedence is unavailable, then in sequences, then free. sequences lists every named sequence slice. Every source read is fail-soft, so a source that is down leaves its facet empty rather than failing the read.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A mailbox overview document, as the app returns it.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string