Attempt cohort analysis

GET

https://api.smallest.ai/atoms/v1/analytics/attempt-cohort

GET

/atoms/v1/analytics/attempt-cohort

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/analytics/attempt-cohort"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "success": true,
3   "data": {
4     "orgId": "org_9f8b7c6d5e4a3b2c1d0e",
5     "cohorts": [
6       {
7         "attemptNumber": 1,
8         "totalCalls": 1500,
9         "answeredCalls": 900,
10         "pickupRate": 0.6,
11         "cumulativeAnswered": 900,
12         "cumulativeRate": 0.6,
13         "marginalGain": 0.6
14       },
15       {
16         "attemptNumber": 2,
17         "totalCalls": 800,
18         "answeredCalls": 320,
19         "pickupRate": 0.4,
20         "cumulativeAnswered": 1220,
21         "cumulativeRate": 0.61,
22         "marginalGain": 0.21
23       },
24       {
25         "attemptNumber": 3,
26         "totalCalls": 400,
27         "answeredCalls": 120,
28         "pickupRate": 0.3,
29         "cumulativeAnswered": 1340,
30         "cumulativeRate": 0.67,
31         "marginalGain": 0.06
32       }
33     ],
34     "totalUniqueNumbers": 1400,
35     "maxAttemptsSeen": 3,
36     "avgAttemptsToPickup": 1.8,
37     "period": {
38       "from": "2023-01-01",
39       "to": "2023-01-31"
40     }
41   }
42 }

Returns cohort analysis of call attempt numbers, showing how pickup rate changes across the 1st, 2nd, 3rd (etc.) attempts to reach the same number, including cumulative rates and marginal gain per additional attempt.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

agentIdstringOptional

Comma-separated agent IDs to filter results

campaignIdstringOptional

Campaign ID to filter results

callTypestringOptional

Type of call to filter (e.g. inbound, outbound)

dateFromdatetimeOptional

Start of date range (ISO 8601)

dateTodatetimeOptional

End of date range (ISO 8601)

Response

Attempt cohort data

successboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error