dashboard:readUser IDRetrieve identities (SIM profiles) ranked by number of active Things: value is the
number of active Things, not bytes.
Results include both public network profiles and private network (Ubiik) profiles.
When a private network profile shares the same name as a public profile, it is suffixed
with (private) — e.g. "Profile F (private)". The source field on each item
indicates "public" or "private".
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.
Top Identities 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.
Single ranked item of a dashboard chart.
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": [
{
"label": "Profile A",
"value": 120,
"source": "public"
},
{
"label": "Profile F (private)",
"value": 8,
"source": "private"
}
]
}
}Was this page helpful?