dashboard:readUser IDRetrieve aggregated KPI big-number metrics for the dashboard summary panel.
Returns a single-element report array containing counts and data-usage totals
broken down by public and private (Ubiik CBRS + edge-cdr) networks:
| Field | Description |
|---|---|
active_things |
Active SIM/IoT things on the public network |
private_active_things |
Active things on private networks (Ubiik CBRS + edge-cdr) |
data_usage / data_usage_unit |
Public network data consumed, auto-scaled to the best unit |
private_data_usage / private_data_usage_unit |
Private network data consumed, auto-scaled |
networks |
Distinct public MNOs seen in the period |
private_networks |
Distinct private network identifiers seen in the period |
first_time_registrations |
First-time network registrations in the period |
groups |
Groups with traffic in the period (the group filter itself is not applied to this count) |
A user restricted to specific groups who holds no groups receives report: [].
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.
Dashboard Summary 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.
Array containing a single summary object with KPI metrics.
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": [
{
"active_things": 1240,
"private_active_things": 38,
"data_usage": 14.57,
"data_usage_unit": "Data/GB",
"private_data_usage": 2.31,
"private_data_usage_unit": "Data/MB",
"networks": 5,
"private_networks": 1,
"first_time_registrations": 12,
"groups": 4
}
]
}
}Was this page helpful?