Skip to content

Get time-series metrics

GET
/v1/metrics/timeseries
curl --request GET \
--url 'https://api.hookbridge.io/v1/metrics/timeseries?window=24h&endpoint_id=ep_550e8400e29b41d4a716446655440000' \
--header 'Authorization: Bearer <token>'

Retrieve time-bucketed delivery metrics for charting and analysis. 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
endpoint_id
string
/^ep_[a-f0-9]{32}$/

Optional filter by endpoint ID

Example
ep_550e8400e29b41d4a716446655440000

Time-series metrics retrieved successfully

Media typeapplication/json
object
data
object
window

Time window for these metrics

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

Start time of this bucket

string format: date-time
succeeded

Successful deliveries in this bucket

integer
failed

Failed deliveries in this bucket

integer
retrying

Messages pending retry in this bucket

integer
total

Total messages in this bucket

integer
avg_latency_ms

Average delivery latency in milliseconds

integer
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
{
"data": {
"window": "24h",
"buckets": [
{
"timestamp": "2025-12-06T00:00:00Z",
"succeeded": 450,
"failed": 5,
"retrying": 10,
"total": 465,
"avg_latency_ms": 180
},
{
"timestamp": "2025-12-06T01:00:00Z",
"succeeded": 520,
"failed": 3,
"retrying": 8,
"total": 531,
"avg_latency_ms": 165
}
]
},
"meta": {
"request_id": "req_xyz123"
}
}

Invalid window or endpoint_id parameter

Media typeapplication/json
object
error
object
code

Machine-readable error code

string
message

Human-readable error message

string
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
{
"error": {
"code": "INVALID_REQUEST",
"message": "endpoint must be a valid HTTPS URL"
},
"meta": {
"request_id": "req_xyz123"
}
}

Unauthorized - Invalid or missing API key

Media typeapplication/json
object
error
object
code

Machine-readable error code

string
message

Human-readable error message

string
meta
object
request_id

Unique identifier for this request (useful for support)

string
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.