Skip to content

Get Sequence Routing Summary

GET
/sequences/{sequence_id}/routing-summary

Which providers this sequence’s recipients sit behind, and what is suppressed.

Two properties that change how the answer should be read:

  • APPROXIMATE - it scans up to 10,000 recipients, not all of them.
  • FAIL-OPEN - on any error every count is zero, so an all-zero summary means “could not compute” just as much as “nothing matched”. Do not render it as a confident zero.

Each recipient lands in exactly ONE bucket, suppression beating routing (bounce > seg > personal), so the buckets partition the scanned set rather than overlapping.

Authorizations

Parameters

Path Parameters

sequence_id
required

Sequence id.

string

Sequence id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Approximate provider-routing and suppression breakdown for the list.

Two properties a caller must not lose:

  • APPROXIMATE - computed by scanning up to 10,000 recipients, not all of them.
  • FAIL-OPEN - on any error every count is zero, so an all-zero summary means “could not compute” just as much as “nothing matched”. Do not render it as a confident zero.

Each recipient counts toward exactly ONE bucket, suppression taking precedence over routing (bounce > seg > personal), so the buckets are a partition and must not be summed alongside each other as if they overlap.

object
bounce_suppressed_count
integer
google_count
integer
m365_count
integer
other_count
integer
personal_suppressed_count
integer
scanned_count
Any of:
integer
seg_suppressed_count
integer
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