netflow_dashboard:readUser IDRetrieve registrable domains ranked by DNS failures (top 15 unless limit says otherwise),
each with its failure rate and the number of clients it affected. Domains are grouped on the
registrable parent (it.example.com and bun.example.com count as example.com), unlike
GET /v1/netflow/dns-top-queries, which uses the full name.
failure_rate and share_of_failures are fractions (0–1). share_of_failures divides by
the account's whole failure count, so the returned rows deliberately do not sum to 1.
DNS figures come from DNS query logs scoped to the account's IP pools; an account with
no IP pools gets zero counts and empty lists. Device filters (iccid, group, mno, …)
narrow the result to the clients whose traffic matches them.
A user restricted to specific groups sees only those groups; one who holds no groups
receives an empty 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_monthsiccidstringFilter by a specific ICCID.
protocolstringFilter by IP protocol number, e.g. 6 = TCP, 17 = UDP (see GET /v1/filters/protocols).
limitintegerNumber of failing-domain rows to return. Values outside 1..100 are clamped and a non-numeric value falls back to the default — never rejected.
Default: 15
DNS Top Failing Domains 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.
All failed queries of the account in the window.
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": {
"failed_queries": 5200,
"total_clients": 929,
"domains": [
{
"domain": "example.com",
"failed": 1300,
"queries": 2000,
"failure_rate": 0.65,
"share_of_failures": 0.25,
"affected_clients": 120
}
]
}
}
}Was this page helpful?