Analytics · Inbox Analytics
Fetches a day × hour heatmap.
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 | |
accountId | string | |
source | string | |
action | string | One of message.received, message.sent, message.read, all |
Example
curl -X GET "https://api.pozy.ai/v1/analytics/inbox/heatmap?fromDate=2026-10-01" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/analytics/inbox/heatmap?fromDate=2026-10-01", {
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/heatmap",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"fromDate": "2026-10-01",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanfromstring (date)tostring (date)Can be null.
bucketsarray of objectdowinteger1 to 7.
hourinteger0 to 23.
receivedintegersentintegerreadinteger
200 response
{
"success": true,
"from": "2026-10-01",
"to": "2026-10-01",
"buckets": [
{
"dow": 1,
"hour": 1,
"received": 1,
"sent": 1,
"read": 1
}
]
}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.