Get Webhook Subscription Metrics

GET

https://api.catenatelematics.com/v2/notifications/webhooks/:webhook_id/metrics

GET

/v2/notifications/webhooks/:webhook_id/metrics

curl https://api.catenatelematics.com/v2/notifications/webhooks/webhook_id/metrics \
     -H "Authorization: Bearer <token>"

{
  "webhook_id": "123e4567-e89b-12d3-a456-426614174000",
  "http_attempts": {
    "6h": 105,
    "24h": 420,
    "7d": 3000,
    "14d": 6500
  },
  "http_success_attempts": {
    "6h": 100,
    "24h": 400,
    "7d": 2800,
    "14d": 6000
  },
  "http_failure_attempts": {
    "6h": 5,
    "24h": 20,
    "7d": 200,
    "14d": 500
  },
  "message_count": {
    "6h": 100,
    "24h": 400,
    "7d": 2800,
    "14d": 6000
  },
  "message_success_count": {
    "6h": 98,
    "24h": 390,
    "7d": 2700,
    "14d": 5800
  },
  "success_rate": {
    "6h": 98,
    "24h": 97,
    "7d": 96,
    "14d": 96
  },
  "avg_response_time_ms": {
    "6h": 150,
    "24h": 160,
    "7d": 155,
    "14d": 158
  },
  "ewma_success_rate": 0.98,
  "dlq_count": 5
}

Get delivery metrics for a webhook subscription.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

webhook_idstringRequiredformat: "uuid"

Response

Successful Response

webhook_idstringformat: "uuid"

The ID of the webhook that the metrics are for

http_attemptsobject

The total number of HTTP requests made (including retries)

http_success_attemptsobject

The number of HTTP requests that received a 2xx response

http_failure_attemptsobject

The number of HTTP requests that failed or received a non-2xx response

message_countobject

The total number of unique messages/events processed (regardless of retries)

message_success_countobject

The number of messages that were successfully delivered (after all retries)

success_rateobject

The success rate of the webhook. Only available if there are at least 200 messages

avg_response_time_msobject

The average response time of the webhook

ewma_success_ratedouble or null

The exponentially weighted moving average success rate of the webhook. If lower than 0.95, the webhook is considered unhealthy and marked as stale.

dlq_countinteger

The number of messages that failed to be delivered, and were put in the DLQ. Messages are stored for 14 days and must be replayed manually.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error