Delivery Stats

GET

https://api.agentphone.to/v1/webhooks/deliveries/stats

GET

/v1/webhooks/deliveries/stats

1 import { AgentPhoneClient } from "agentphone";
2 
3 async function main() {
4     const client = new AgentPhoneClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.webhooks.deliveryStats({});
8 }
9 main();

1 {
2   "total": 1500,
3   "success": 1400,
4   "failed": 75,
5   "pending": 25,
6   "successRate": 0.9333,
7   "byEventType": {
8     "call_initiated": {
9       "success": 700,
10       "failed": 20,
11       "pending": 10
12     },
13     "call_answered": {
14       "success": 500,
15       "failed": 30,
16       "pending": 10
17     },
18     "call_ended": {
19       "success": 200,
20       "failed": 25,
21       "pending": 5
22     }
23   },
24   "byHour": [
25     {
26       "hour": "2024-06-20T00:00:00Z",
27       "total": 100,
28       "success": 95,
29       "failed": 3,
30       "pending": 2
31     },
32     {
33       "hour": "2024-06-20T01:00:00Z",
34       "total": 120,
35       "success": 110,
36       "failed": 5,
37       "pending": 5
38     },
39     {
40       "hour": "2024-06-20T02:00:00Z",
41       "total": 130,
42       "success": 120,
43       "failed": 7,
44       "pending": 3
45     }
46   ]
47 }

Aggregated delivery stats for the project's webhooks over the last N hours.

Authentication

AuthorizationBearer

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

Query parameters

hoursintegerOptional1-168Defaults to 24

Response

Successful Response

totalinteger

successinteger

failedinteger

pendinginteger

successRatedouble

byEventTypemap from strings to maps from strings to integers

byHourlist of objects

Errors

422

Unprocessable Entity Error