Get overview aggregates for webhook events

Get overview aggregates for webhook events including success/failure rates

GET /api/v2/webhook-events/summary

Get overview aggregates for webhook events

cURL

curl --request GET \
  --url https://api.instantly.ai/api/v2/webhook-events/summary \
  --header 'Authorization: Bearer <token>'

200

{
  "total_events": 100,
  "successful_events": 100,
  "failed_events": 100,
  "success_rate": 50,
  "failure_rate": 50
}

Authorizations

Authorization · string · header · required

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

Query Parameters

from · string<date>

Inclusive start of the window (YYYY-MM-DD).

Example:

"2024-01-01"

to · string<date>

Inclusive end of the window (YYYY-MM-DD).

Example:

"2024-01-31"

Response

200

application/json

Default Response

total_events · number · required

Total number of webhook events

Example:

100

successful_events · number · required

Total number of successful webhook events

Example:

100

failed_events · number · required

Total number of failed webhook events

Example:

100

success_rate · number · required

Percentage (0-100) of successful webhook calls

Example:

50

failure_rate · number · required

Percentage (0-100) of failed webhook calls

Example:

50