GET
/
v3
/
webhooks
/
{botId}
/
metrics
cURL
curl --request GET \
  --url http://127.0.0.1:3333/v3/webhooks/{botId}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "scope": {
    "workspaceId": "<string>",
    "botId": "<string>",
    "webhookId": "<string>"
  },
  "timeRange": "24h",
  "windowStart": "<string>",
  "windowEnd": "<string>",
  "deliveries": {
    "total": 123,
    "queued": 123,
    "processing": 123,
    "success": 123,
    "failed": 123,
    "dead": 123
  },
  "latency": {
    "sampleSize": 123,
    "p50Ms": 123,
    "p95Ms": 123,
    "p99Ms": 123
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

botId
string
required

Query Parameters

workspaceId
string
required
webhookId
string
timeRange
enum<string>
default:24h
Available options:
24h,
7d,
30d

Response

200 - application/json

Default Response

scope
object
required
timeRange
enum<string>
required
Available options:
24h,
7d,
30d
windowStart
string
required
windowEnd
string
required
deliveries
object
required
latency
object
required