Skip to main content
GET
Top carrier rejection codes for a funnel drop-off step

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

step
enum<string>
required

Funnel stage to explain. sent returns rejection codes for messages that were sent but never delivered; other steps are reserved and return an empty list.

Available options:
sent,
delivered,
read,
queued

Query Parameters

start_date
string<date>

Inclusive start of the reporting window (ISO-8601 date or datetime). Defaults to the last 30 days when omitted.

end_date
string<date>

Inclusive end of the reporting window (ISO-8601 date or datetime).

days
integer

Alternative rolling lookback in whole days. Mutually exclusive with an explicit start/end range.

Required range: x >= 1
channel
string

Optional single-channel filter (e.g. sms, whatsapp, email).

limit
integer
default:5

Maximum number of error codes to return.

Required range: 1 <= x <= 20

Response

200 - application/json

Top rejection codes for the step, resolved to readable names and categories.

data
object
meta
object