Get pull event metrics

GET

/v1/pull-metrics

curl --request GET \
  --url 'https://api.hookbridge.io/v1/pull-metrics?window=1h' \
  --header 'Authorization: Bearer <token>'

• Production

Retrieve aggregated metrics for pull events including counts of stored and delivered events.

Authorizations

• BearerAuth

Parameters

Query Parameters

window

string

default: 24h

Allowed values: 1h 24h 7d 30d

Time window for aggregation

pull_endpoint_id

string format: uuid

Filter metrics by specific pull endpoint

Responses

200

Pull metrics retrieved successfully

Media typeapplication/json

object

data

object

window

Time window for these metrics

string

Allowed values: 1h 24h 7d 30d

total_messages

Total number of messages in the window

integer

succeeded

Number of successfully delivered messages

integer

failed

Number of permanently failed messages

integer

retries

Total number of retry attempts

integer

success_rate

Ratio of succeeded messages to total messages

number format: float

avg_latency_ms

Average delivery latency in milliseconds

integer

avg_delivery_time_ms

Average total delivery time (created_at to delivered_at) for succeeded messages

integer

avg_queue_wait_ms

Average queue wait time (created_at to first_attempt_at) for attempted messages

integer

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "data": {
    "window": "1h",
    "total_messages": 10000,
    "succeeded": 9950,
    "failed": 50,
    "retries": 150,
    "success_rate": 0.995,
    "avg_latency_ms": 185
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

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

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

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