Skip to content

Get Deliverability Metrics

GET
/deliverability/metrics

Deliverability capacity / sends / placement / warmup for the caller’s org.

Read-only, org-scoped (schema = str(org_id).lower()). Reuses the admin dashboard’s capacity+sends helpers (issue #14279) and the aggregator’s honest placement bucketing (issue #14278) so the numbers match the internal dashboard by construction. Every signal fails soft to null — a missing ClickHouse / placement source degrades the field, never the whole response.

Authorizations

Parameters

Query Parameters

days

Trailing window in days

integer
default: 7 >= 1 <= 30

Trailing window in days

mailbox_id
Any of:
integer

Drill into one mailbox’s slice

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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