dashboard:readUser IDRetrieve the insights tile: inbox events in the window aggregated per event type. Each row
carries the event type in both message and event_type, and the number of events as a
string in create_date.
Inbox events carry no group, network or profile, so those filters do not narrow this tile
and applied_filters echoes only from and to.
This endpoint has a built-in 28-second graceful timeout: if the data source does not
respond in time, the API returns HTTP 200 with an empty report: [] and applied_filters: {}
rather than an error. Treat an empty report as a soft degradation, not a failure.
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.
Insights 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.
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": [
{
"message": "Things Data Limit",
"create_date": "12",
"event_type": "Things Data Limit"
}
]
}
}Was this page helpful?