Online Usage data
This endpoint allow you to get your account's online usage data.
The data is always updated to yesterday.
There is a rate limit of 10 requests per minute to avoid abuse.
Settings:
URL | |
Method | JSON via POST |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example | Maximum length | Mandatory | Example |
month | the month + year in mmyy format | 4 | Yes | 1026 |
server | server name, if relevant | 30 | no | online |
account_id | In case you want to get data of specific account id | 5 | no | 1 |
Response:
{
"status": "OK",
"reason": 1,
"month": "0926",
"month_label": "09/2026",
"is_current_month": false,
"server": null,
"account_id": null,
"totalAccounts": 1,
"list": [
{
"month": "0926",
"month_label": "09/2026",
"year": 2026,
"account_id": 123,
"account_name": "Client Name",
"online_name": "Client Name Ltd",
"server": "online",
"server_name": "online",
"total_agents": 5,
"data_amount": "74.3GB",
"data_amount_gb": 74.3,
"total_inboxes": 6,
"inboxes": {
"whatsapp": 2, "sms": 1, "facebook": 1, "api": 1,
"website": 1, "email": 0, "line": 0, "tiktok": 0
},
"sms_packages": { "1": 1, "2": 0, "3": 0 },
"chat_gpt": true,
"builder": false,
"mobile_app": true,
"docal_enabled": false,
"collected_at": 1790805612,
"collected_at_israel": "01-10-2026 01:00:12"
}
]
}
Response-Explain:
Parameter | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
status | OK or FAIL "OK" means the request was successful "Fail" means error. | |||||||||||||||||||||||||||||||||||||||||||||||||||
month | string, same as the request | |||||||||||||||||||||||||||||||||||||||||||||||||||
month_label | string, the request in format mm/yyyy | |||||||||||||||||||||||||||||||||||||||||||||||||||
is_current_month | boolean. true = current month false = old month | |||||||||||||||||||||||||||||||||||||||||||||||||||
server | string / null. the server filter you provided | |||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | number / null The account filter you provider | |||||||||||||||||||||||||||||||||||||||||||||||||||
totalAccounts | number total accounts in the items inside 'list" | |||||||||||||||||||||||||||||||||||||||||||||||||||
list | array. one item per online account per server. sorted by server, then account_id. empty if there is no data. list contains this:
| |||||||||||||||||||||||||||||||||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|