Analytics · Inbox Analytics
Fetches top accounts by inbox volume.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
fromDaterequired | string (date) | |
toDate | string (date) | |
profileId | string | |
platform | string | |
source | string | |
limit | integer | Default 101 to 50 |
Example
curl -X GET "https://api.pozy.ai/v1/analytics/inbox/top-accounts?fromDate=2026-10-01&limit=10" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/analytics/inbox/top-accounts?fromDate=2026-10-01&limit=10", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/analytics/inbox/top-accounts",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"fromDate": "2026-10-01",
"limit": 10,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanfromstring (date)tostring (date)Can be null.
accountsarray of object10 child fields
accountIdstringplatformstringdisplayNamestringusernamestringreceivedintegersentintegertotalintegerconversationsintegermedianResponseSecondsintegerrepliedCountinteger
200 response
{
"success": true,
"from": "2026-10-01",
"to": "2026-10-01",
"accounts": [
{
"accountId": "696e0b682d0a31188e7a2ba9",
"platform": "instagram",
"displayName": "Acme",
"username": "acme",
"received": 1,
"sent": 1,
"total": 42,
"conversations": 1,
"medianResponseSeconds": 1,
"repliedCount": 42
}
]
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.