Get time-series metrics

GET

/v1/metrics/timeseries

• Production

Retrieve time-bucketed delivery metrics for charting and analysis. Returns data points at intervals appropriate for the selected window.

Authorizations

• BearerAuth

Parameters

Query Parameters

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

Responses

200

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": 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"
  }
}

400

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

401

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"
  }
}