Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB
Metrics

Get Attempt Metrics

Returns aggregated delivery attempt metrics. Supports time bucketing via granularity, dimensional grouping, and filtering.

Measures: count, successful_count, failed_count, error_rate, first_attempt_count, retry_count, manual_retry_count, avg_attempt_number, rate, successful_rate, failed_rate

Dimensions: tenant_id (admin-only), destination_id, destination_type, topic, status, code, manual, attempt_number

Filters: tenant_id (admin-only), destination_id, destination_type, topic, status, code, manual, attempt_number

get/metrics/attempts

Query parameters

startstring date-time required

Start of the time range (inclusive). ISO 8601 timestamp.

endstring date-time required

End of the time range (exclusive). ISO 8601 timestamp.

Time range for the metrics query.

{
  "start": "2026-03-02T00:00:00Z",
  "end": "2026-03-03T00:00:00Z"
}
granularitystring

Time bucketing granularity. Pattern: <number><unit>. Units: s (1-60), m (1-60), h (1-24), d (1-31), w (1-4), M (1-12). When omitted, returns a single aggregate row per dimension combination.

'count' | 'successful_count' | 'failed_count' | 'error_rate' | 'first_attempt_count' | 'retry_count' | 'manual_retry_count' | 'avg_attempt_number' | 'rate' | 'successful_rate' | 'failed_rate' required
OR
string[] required

Measures to compute. At least one required. Rate measures (rate, successful_rate, failed_rate) are throughput in events/second. Use bracket notation for multiple values (e.g., measures[0]=count&measures[1]=error_rate).

'tenant_id' | 'destination_id' | 'destination_type' | 'topic' | 'status' | 'code' | 'manual' | 'attempt_number'
OR
string[]

Dimensions to group results by. Use bracket notation for multiple values (e.g., dimensions[0]=status&dimensions[1]=destination_id).

string
OR
string[]

Filter by destination ID(s). Use bracket notation for multiple values (e.g., filters[destination_id][0]=d1&filters[destination_id][1]=d2).

'webhook' | 'aws_sqs' | 'rabbitmq' | 'hookdeck' | 'aws_kinesis' | 'azure_servicebus' | 'aws_s3' | 'gcp_pubsub'

Type of destination.

OR
DestinationType[]
Example:webhook

Filter by destination type(s). Use bracket notation for multiple values (e.g., filters[destination_type][0]=webhook&filters[destination_type][1]=aws_sqs).

string
OR
string[]

Filter by topic name(s). Use bracket notation for multiple values (e.g., filters[topic][0]=user.created&filters[topic][1]=user.updated).

'success' | 'failed'
OR
string[]

Filter by attempt status(es). Use bracket notation for multiple values (e.g., filters[status][0]=success&filters[status][1]=failed).

string
OR
string[]

Filter by HTTP status code(s). Use bracket notation for multiple values (e.g., filters[code][0]=200&filters[code][1]=500).

filters[manual]'true' | 'false'

Filter by manual retry flag.

string
OR
string[]

Filter by attempt number(s). Use bracket notation for multiple values (e.g., filters[attempt_number][0]=1&filters[attempt_number][1]=2).

string
OR
string[]

Filter by tenant ID(s). Admin-only — rejected with 403 for JWT callers. Use bracket notation for multiple values (e.g., filters[tenant_id][0]=t1&filters[tenant_id][1]=t2).

Response

Aggregated attempt metrics.

Example response

{
  "data": [
    {
      "time_bucket": "2026-03-02T14:00:00Z",
      "dimensions": {
        "destination_id": "dest_abc",
        "topic": "user.created"
      },
      "metrics": {
        "count": 1423,
        "error_rate": 0.02
      }
    }
  ],
  "metadata": {
    "granularity": "1h",
    "query_time_ms": 42,
    "row_count": 2,
    "row_limit": 100000
  }
}