Skip to main content
GET
Retrieve endpoint delivery metrics

Path Parameters

endpoint_id
string
required

The webhook endpoint's ID.

Query Parameters

period
string

Grouping period, e.g. day.

date_from
string<date-time>

Start of the range (ISO 8601).

date_to
string<date-time>

End of the range (ISO 8601).

Response

Delivery metrics.

Delivery metrics for an endpoint over a time range.

total
string
required

The number of delivery attempts across the whole range, as a string. It equals the sum of success and failed over every entry in data, so use it to compute a success rate without re-adding the series.

Example:

"160"

period
string
required

How the series is bucketed. day: one entry per calendar day (the default, over the last 30 days when you send no dates). week: one entry per week. month: one entry per month. An unrecognised value falls back to day.

Example:

"day"

data
object[]
required

One entry per bucket in the range, in ascending time order. Buckets with no attempts are still returned with zero counts, so the series is safe to plot without filling gaps yourself.