netflow_dashboard:readUser IDRetrieve an aggregated view of the account's NetFlow traffic for the network-diagram UI: totals, DNS/cloud traffic, the busiest remote hosts and SIM groups, the edges between them, the facet values present, and top-N insights.
The keys of the by_* and protocols maps are names from the data, normalized to lower
snake_case (e.g. TCP → tcp, United States → united_states).
A brand with no Console customer is 400.
fromdate-timeWindow start in ISO 8601. Defaults to 2 hours before to. Must not be after to (400).
There is no maximum window. (start_time/end_time are not accepted here.)
todate-timeWindow end in ISO 8601. Defaults to now.
iccidstringFilter by ICCID (with or without the ThingId_ICCID_ prefix).
thing_idstringFilter by ThingId (e.g. ThingId_ICCID_…).
imeistringFilter by IMEI.
imsistringFilter by IMSI.
source_ipstringFilter by source IPv4 address.
destination_ipstringFilter by destination IPv4 address (post-NAT).
destination_portintegerFilter by destination port.
protocolarrayFilter by IP protocol number(s), e.g. 6 = TCP, 17 = UDP. Repeat the parameter to pass several values.
directionarrayFilter by traffic direction(s) (inbound, outbound). Repeat the parameter to pass several values.
classificationarrayFilter by traffic classification(s). Repeat the parameter to pass several values.
countryarrayFilter by country or countries. Repeat the parameter to pass several values.
mno_namearrayFilter by MNO name(s). Repeat the parameter to pass several values.
apnstringFilter by APN.
sim_grouparrayFilter by SIM group name(s). Repeat the parameter to pass several values.
tacarrayFilter by TAC prefix(es) of the IMEI (first 8 digits). Repeat the parameter to pass several values.
host_iparrayFilter by host IP address(es), matched against either the source or the destination. Repeat the parameter to pass several values.
dns_namestringFilter by DNS question name.
hosts_sizeintegerMaximum number of hosts to return (1–500). hosts never holds more than this; edges to hosts beyond the cut are dropped.
Default: 200
groups_sizeintegerMaximum number of groups to return (1–500).
Default: 200
Network diagram summary retrieved successfully
HTTP status code
Response message
Bytes per traffic classification.
Bytes in/out per protocol name.
Bytes per country.
Bytes per APN.
Edges between a SIM group and the cloud (group_id is the group node).
Edges between the cloud and a remote host (host_id is the host node).
Internal traffic of a SIM group (classification internal).
Distinct values present in the window, for filter pickers.
Top-5 lists.
Unique request ID for tracking
Example
{
"status_code": 200,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"window": {
"from": "2026-03-23T13:00:00.000Z",
"to": "2026-03-23T15:00:00.000Z",
"total_records": 1520
},
"totals": {
"bytes_in": 8388608,
"bytes_out": 1048576,
"total_bytes": 9437184,
"total_packets": 12000,
"by_classification": {
"internet": 9437184
},
"by_protocol": {
"tcp": {
"bytes_in": 8000000,
"bytes_out": 1000000
}
},
"by_country": {
"italy": 9437184
},
"by_apn": {
"iot_example": 9437184
}
},
"cloud": {
"dns_bytes": 20480,
"dns_packets": 160,
"dns_bytes_in": 12288,
"dns_bytes_out": 8192,
"dns_resolvers": [
{
"ip": "100.100.96.1",
"bytes_in": 12288,
"bytes_out": 8192,
"packets": 160
}
],
"public_ips": [
{
"ip": "203.0.113.10"
}
]
},
"hosts": [
{
"id": "host-142.250.74.110",
"ip": "142.250.74.110",
"dns_name": "www.google.com",
"total_bytes": 409600,
"bytes_in": 307200,
"bytes_out": 102400,
"packets": 600,
"classifications": [
"internet"
],
"connected_groups": [
"Test Warehouse"
],
"protocols": {
"tcp": {
"bytes_in": 307200,
"bytes_out": 102400
}
}
}
],
"groups": [
{
"id": "group-Test Warehouse",
"name": "Test Warehouse",
"total_bytes": 409600,
"bytes_in": 307200,
"bytes_out": 102400,
"packets": 600,
"device_count": 12,
"connected_hosts": [
"142.250.74.110"
],
"classifications": [
"internet"
],
"protocols": {
"tcp": {
"bytes_in": 307200,
"bytes_out": 102400
}
},
"sim_countries": [
"Italy"
]
}
],
"edges": {
"group_edges": [],
"host_edges": [],
"internal_edges": []
},
"facets": {
"classifications": [
"internet"
],
"countries": [
"Italy"
],
"mnos": [
"VODAFONE ITALIA S.P.A"
],
"protocols": [
"TCP"
],
"tacs": [
"35373511"
],
"sim_groups": [
"Test Warehouse"
]
},
"insights": {
"top_mnos": [],
"top_groups": [],
"top_devices": [],
"top_flows": [],
"top_dns_queries": [],
"top_talkers": [],
"top_hosts": []
}
}
}Was this page helpful?