Get Webhook delivery health dashboard

Returns Webhook delivery statistics for specified time range. If time range not specifed provides statustics for last 24 hours.

Query Parameters

• from int64

  Unix time used to get entities in a specific time window.

  • Used in conjunction with timeTo param
• to int64

  Unix time used to get entities in a specific time window.

  • Used in conjunction with timeFrom param
• filter object

  Filtering options for Webhook delivery statistics

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• success_rate float

  Delivery success rate

• delivered int64

  Successfully delivered Webhooks

• failed integer

  Failed to delivery Webhooks

• retrying int64

  Webhooks with 'retrying' status

{
  "success_rate": 99.6,
  "delivered": 996,
  "failed": 2,
  "retrying": 2
}

{
  "success_rate": 99.6,
  "delivered": 996,
  "retrying": 2,
  "failed": 2
}

• Wrong time period
• Wrong event type

application/json

• Schema
• Example (from schema)
• Wrong event type

---

Schema

• error string

  Error message

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong event type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...