Get webhook delivery statistics

const url = 'https://saperly.com/api/v1/webhooks/stats';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "total": 1200,
  "success": 1140,
  "failed": 60,
  "successRate": 0.95,
  "byEventType": {
    "message_sent": 800,
    "message_delivered": 350,
    "message_failed": 50
  },
  "byHour": [
    {
      "hour": "2024-06-14T14:00:00Z",
      "total": 50,
      "success": 48,
      "failed": 2
    },
    {
      "hour": "2024-06-14T15:00:00Z",
      "total": 55,
      "success": 52,
      "failed": 3
    },
    {
      "hour": "2024-06-14T16:00:00Z",
      "total": 60,
      "success": 57,
      "failed": 3
    },
    {
      "hour": "2024-06-14T17:00:00Z",
      "total": 45,
      "success": 43,
      "failed": 2
    },
    {
      "hour": "2024-06-14T18:00:00Z",
      "total": 40,
      "success": 38,
      "failed": 2
    },
    {
      "hour": "2024-06-14T19:00:00Z",
      "total": 55,
      "success": 52,
      "failed": 3
    },
    {
      "hour": "2024-06-14T20:00:00Z",
      "total": 50,
      "success": 48,
      "failed": 2
    },
    {
      "hour": "2024-06-14T21:00:00Z",
      "total": 55,
      "success": 53,
      "failed": 2
    },
    {
      "hour": "2024-06-14T22:00:00Z",
      "total": 60,
      "success": 57,
      "failed": 3
    },
    {
      "hour": "2024-06-14T23:00:00Z",
      "total": 55,
      "success": 52,
      "failed": 3
    },
    {
      "hour": "2024-06-15T00:00:00Z",
      "total": 50,
      "success": 48,
      "failed": 2
    },
    {
      "hour": "2024-06-15T01:00:00Z",
      "total": 45,
      "success": 43,
      "failed": 2
    },
    {
      "hour": "2024-06-15T02:00:00Z",
      "total": 40,
      "success": 38,
      "failed": 2
    },
    {
      "hour": "2024-06-15T03:00:00Z",
      "total": 35,
      "success": 33,
      "failed": 2
    },
    {
      "hour": "2024-06-15T04:00:00Z",
      "total": 30,
      "success": 29,
      "failed": 1
    },
    {
      "hour": "2024-06-15T05:00:00Z",
      "total": 25,
      "success": 24,
      "failed": 1
    },
    {
      "hour": "2024-06-15T06:00:00Z",
      "total": 20,
      "success": 19,
      "failed": 1
    },
    {
      "hour": "2024-06-15T07:00:00Z",
      "total": 15,
      "success": 14,
      "failed": 1
    },
    {
      "hour": "2024-06-15T08:00:00Z",
      "total": 10,
      "success": 10,
      "failed": 0
    },
    {
      "hour": "2024-06-15T09:00:00Z",
      "total": 5,
      "success": 5,
      "failed": 0
    },
    {
      "hour": "2024-06-15T10:00:00Z",
      "total": 8,
      "success": 7,
      "failed": 1
    },
    {
      "hour": "2024-06-15T11:00:00Z",
      "total": 12,
      "success": 11,
      "failed": 1
    },
    {
      "hour": "2024-06-15T12:00:00Z",
      "total": 18,
      "success": 17,
      "failed": 1
    },
    {
      "hour": "2024-06-15T13:00:00Z",
      "total": 22,
      "success": 21,
      "failed": 1
    }
  ]
}

Returns aggregate statistics on webhook deliveries including success rate and hourly breakdown.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Query parameters

line_idstringOptionalformat: "uuid"

Filter by line ID

Response

Webhook statistics

totalinteger

Total deliveries

successinteger

Successful deliveries

failedinteger

Failed deliveries

successRatedouble

Success rate as a decimal (0-1)

byEventTypemap from strings to integers

Delivery counts grouped by event type

byHourlist of objects

Delivery counts by hour for the last 24 hours

Errors

401

Unauthorized Error