dashboard:readUser IDRetrieve the data-usage time series for the dashboard: one point per day (per hour for
windows of 48 hours or less), each with public-network, private-network and total bytes.
usage is a deprecated alias of public_usage.
usage_summary carries per-series totals and render hints. private_network_available: false
means private-network usage could not be queried at all — the private series is unknown,
not zero.
start_timedate-timeStart time for the report in ISO 8601 UTC format.
Either period, or both start_time and end_time, must be sent — otherwise 422.
When both are sent, start_time/end_time take precedence over period.
end_timedate-timeEnd time for the report in ISO 8601 UTC format. Required together with start_time.
Must not be before start_time, and the range cannot exceed 180 days (422).
periodstringPredefined report period. Required unless both start_time and end_time are sent.
todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_monthsprofilestringFilter by Profile name (see GET /v1/filters/profiles). A name that matches no known
profile yields an empty report rather than an unfiltered one.
Data Usage retrieved successfully
HTTP status code
Response message
The filters that were applied to generate the report, echoed under the query-parameter names that were sent. Only filters that were sent are present.
Start timestamp of the report range (UTC).
End timestamp of the report range (UTC).
Filtered country.
Filtered group name.
Filtered MNO.
Filtered profile name.
Filtered breakout.
Filtered IP protocol number.
Filtered ICCID.
Whether the public series carries any usage.
Whether the private series carries any usage.
Whether private-network usage could be queried at all.
Unique request ID for tracking
Example
{
"status_code": 200,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"applied_filters": {
"from": "2026-01-25T00:00:00Z",
"to": "2026-01-26T00:00:00Z"
},
"report": [
{
"datetime": "2026-01-25T00:00:00.000Z",
"usage": 1048576,
"public_usage": 1048576,
"private_usage": 0,
"total_usage": 1048576
}
],
"usage_summary": {
"public_total": 1048576,
"private_total": 0,
"total": 1048576,
"has_public": true,
"has_private": false,
"private_network_available": true
}
}
}Was this page helpful?