Skip to main content
GET
/
webhooks
/
{id}
/
stats
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/webhooks/{id}/stats \
  --header 'Authorization: Bearer <token>'
{
  "totalDeliveries": 1,
  "succeeded": 1,
  "failed": 1,
  "pending": 1,
  "successRate": 50
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

​
id
string
required

Unique identifier of the webhook to get stats for

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

Aggregate delivery statistics for a webhook endpoint

​
totalDeliveries
integer
required

Total number of deliveries ever created

Required range: x >= 0
​
succeeded
integer
required

Number of deliveries that completed successfully

Required range: x >= 0
​
failed
integer
required

Number of deliveries that exhausted all retries

Required range: x >= 0
​
pending
integer
required

Number of deliveries awaiting retry

Required range: x >= 0
​
successRate
number
required

Percentage of successful deliveries

Required range: 0 <= x <= 100