Skip to content

Get Bounce Classes

GET
/inbox/reporting/bounce-classes

Delivery-failure (bounce) counts by class, mailbox or list.

Counts only DSNs from mailboxes the key may see; personal-mailbox volume of other people never contributes. list grouping additionally requires the key to see the list. No bodies, recipients or diagnostics are returned.

Authorizations

Parameters

Query Parameters

since
required

Inclusive ISO-8601 timestamp WITH timezone.

string format: date-time

Inclusive ISO-8601 timestamp WITH timezone.

group_by
string
default: class
Allowed values: mailbox list class

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

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