Skip to content

Get inbound time-series metrics

GET
/v1/inbound-metrics/timeseries

Retrieve time-bucketed delivery metrics for inbound webhook messages. Returns data points at intervals appropriate for the selected window.

window
string
default: 24h
Allowed values: 1h 24h 7d 30d

Time window for metrics

Example
24h
inbound_endpoint_id
string format: uuid

Optional filter by inbound endpoint ID

Example
01935abc-def0-7123-4567-890abcdef012

Inbound time-series metrics retrieved successfully

object
data
object
window

Time window for these metrics

string
Allowed values: 1h 24h 7d 30d
Example
24h
buckets
Array<object>
object
timestamp

Start time of this bucket

string format: date-time
Example
2025-12-06T00:00:00Z
succeeded

Successful deliveries in this bucket

integer
Example
450
failed

Failed deliveries in this bucket

integer
Example
5
retrying

Messages pending retry in this bucket

integer
Example
10
total

Total messages in this bucket

integer
Example
465
avg_latency_ms

Average delivery latency in milliseconds

integer
Example
180
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"data": {
"window": "24h",
"buckets": [
{
"timestamp": "2025-12-06T00:00:00Z",
"succeeded": 200,
"failed": 2,
"retrying": 5,
"total": 207,
"avg_latency_ms": 145
},
{
"timestamp": "2025-12-06T01:00:00Z",
"succeeded": 220,
"failed": 1,
"retrying": 3,
"total": 224,
"avg_latency_ms": 130
}
]
},
"meta": {
"request_id": "req_xyz123"
}
}

Invalid window or endpoint_id parameter

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123

Unauthorized - Invalid or missing API key

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"request_id": "req_xyz123"
}
}
Personalize Examples

Enter your credentials to populate code examples throughout the docs.