Get pull event time-series metrics

GET

/v1/pull-metrics/timeseries

• Production

Retrieve time-bucketed pull event 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

pull_endpoint_id

string format: uuid

Filter by specific pull endpoint

Responses

200

Pull time-series metrics retrieved successfully

object

data

object

window

string

Allowed values: 1h 24h 7d 30d

buckets

Array<object>

object

timestamp

Start time of this bucket

string format: date-time

Example

2025-12-06T00:00:00Z

succeeded

Delivered (acknowledged) messages in this bucket

integer

Example

450

stored

Messages received but not yet fetched by the customer

integer

Example

10

fetched

Messages fetched by the customer but not yet acknowledged

integer

Example

5

total

Total messages received in this bucket

integer

Example

465

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

400

Invalid request

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

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "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"
  }
}