Get inbound metrics

GET

/v1/inbound-metrics

• Production

Retrieve aggregated delivery metrics for inbound webhook messages. Optionally filter by a specific inbound endpoint.

Authorizations

• BearerAuth

Parameters

Query Parameters

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

Responses

200

Inbound metrics retrieved successfully

object

data

object

window

Time window for these metrics

string

Allowed values: 1h 24h 7d 30d

Example

24h

total_messages

Total number of inbound messages in the window

integer

Example

5000

succeeded

Successfully delivered messages

integer

Example

4900

failed

Permanently failed messages

integer

Example

20

retries

Total retry attempts

integer

Example

80

success_rate

Ratio of succeeded to total messages

number format: float

Example

0.98

avg_latency_ms

Average delivery latency in milliseconds

integer

Example

150

avg_delivery_time_ms

Average total time from received to delivered in milliseconds

integer

Example

3200

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "window": "24h",
    "total_messages": 5000,
    "succeeded": 4900,
    "failed": 20,
    "retries": 80,
    "success_rate": 0.98,
    "avg_latency_ms": 150,
    "avg_delivery_time_ms": 3200
  },
  "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"
  }
}