get

api.monogoto.io/v1/netflow/dns-clients-affected

Get DNS Clients Affected

Scopes

netflow_dashboard:read

Rate limited

60 reqevery 1 minute·keyed byUser ID

Retrieve unique DNS client counts: all clients, those that saw at least one failed (non-NOERROR) response (affected_clients), and the remainder (unaffected_clients), so the last two always sum to total_clients. by_response_code splits queries and clients per DNS response code; its clients counts must not be summed — a client that resolved some names and failed others appears under both codes.

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: [].

Parameters

Query

start_timedate-time

optional

Start 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-time

optional

End 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).

periodstring

optional

Predefined report period. Required unless both start_time and end_time are sent.

enum:todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_months

iccidstring

optional

Filter by a specific ICCID.

profilestring

optional

Filter by Profile name (see GET /v1/filters/profiles).

See valid values

mnostring

optional

Filter by MNO name (see GET /v1/filters/mno).

See valid values

groupstring

optional

Filter by Group name (see GET /v1/filters/groups).

See valid values

countrystring

optional

Filter by Country (see GET /v1/filters/countries).

See valid values

protocolstring

optional

Filter by IP protocol number, e.g. 6 = TCP, 17 = UDP (see GET /v1/filters/protocols).

See valid values

breakoutstring

optional

Filter by Breakout (see GET /v1/filters/breakout).

See valid values

Responses

DNS Clients Affected retrieved successfully

application/json

object

status_codeinteger

required

HTTP status code

messagestring

required

Response message

dataobject

required

applied_filtersobject

required

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.

fromstring · date-time

optional

Start timestamp of the report range (UTC).

tostring · date-time

optional

End timestamp of the report range (UTC).

countrystring

optional

Filtered country.

groupstring

optional

Filtered group name.

mnostring

optional

Filtered MNO.

profilestring

optional

Filtered profile name.

breakoutstring

optional

Filtered breakout.

protocolstring

optional

Filtered IP protocol number.

iccidstring

optional

Filtered ICCID.

reportobject

required

total_clientsinteger

optional

affected_clientsinteger

optional

unaffected_clientsinteger

optional

total_queriesinteger

optional

failed_queriesinteger

optional

by_response_codearray[object]

optional

request_idstring

required

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": {
      "total_clients": 929,
      "affected_clients": 413,
      "unaffected_clients": 516,
      "total_queries": 120000,
      "failed_queries": 5200,
      "by_response_code": [
        {
          "response_code": "NOERROR",
          "queries": 114800,
          "clients": 929
        },
        {
          "response_code": "NXDOMAIN",
          "queries": 4100,
          "clients": 390
        }
      ]
    }
  }
}

GET

Get Enriched NetFlow Data

/v1/netflow/enriched

GET

Get Network Diagram Summary

/v1/netflow/networkdiagram-summary

GET

Get Top Destinations

/v1/netflow/top-destinations

GET

Get Data Transfer

/v1/netflow/data-transfer

GET

Get Services

/v1/netflow/services

Was this page helpful?

curl -X GET 'https://api.monogoto.io/v1/netflow/dns-clients-affected?start_time=2026-01-25T00%3A00%3A00Z&end_time=2026-01-26T00%3A00%3A00Z&period=last_30_days&iccid=8988223000000000001&profile=Profile%20A&mno=VODAFONE%20ITALIA%20S.P.A&group=Test%20Warehouse&country=United%20States&protocol=6&breakout=Frankfurt' \ -H 'Authorization: Bearer $TOKEN'

{ "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": { "total_clients": 929, "affected_clients": 413, "unaffected_clients": 516, "total_queries": 120000, "failed_queries": 5200, "by_response_code": [ { "response_code": "NOERROR", "queries": 114800, "clients": 929 }, { "response_code": "NXDOMAIN", "queries": 4100, "clients": 390 } ] } } }

Parameters

Query

start_timedate-time

optional

end_timedate-time

optional

End 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).

periodstring

optional

Predefined report period. Required unless both start_time and end_time are sent.

enum:todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_months

iccidstring

optional

Filter by a specific ICCID.

profilestring

optional

Filter by Profile name (see GET /v1/filters/profiles).

See valid values

mnostring

optional

Filter by MNO name (see GET /v1/filters/mno).

See valid values

groupstring

optional

Filter by Group name (see GET /v1/filters/groups).

See valid values

countrystring

optional

Filter by Country (see GET /v1/filters/countries).

See valid values

protocolstring

optional

Filter by IP protocol number, e.g. 6 = TCP, 17 = UDP (see GET /v1/filters/protocols).

See valid values

breakoutstring

optional

Filter by Breakout (see GET /v1/filters/breakout).

See valid values

Responses

DNS Clients Affected retrieved successfully

application/json

object

status_codeinteger

required

HTTP status code

messagestring

required

Response message

dataobject

required

applied_filtersobject

required

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.

fromstring · date-time

optional

Start timestamp of the report range (UTC).

tostring · date-time

optional

End timestamp of the report range (UTC).

countrystring

optional

Filtered country.

groupstring

optional

Filtered group name.

mnostring

optional

Filtered MNO.

profilestring

optional

Filtered profile name.

breakoutstring

optional

Filtered breakout.

protocolstring

optional

Filtered IP protocol number.

iccidstring

optional

Filtered ICCID.

reportobject

required

total_clientsinteger

optional

affected_clientsinteger

optional

unaffected_clientsinteger

optional

total_queriesinteger

optional

failed_queriesinteger

optional

by_response_codearray[object]

optional

request_idstring

required

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": {
      "total_clients": 929,
      "affected_clients": 413,
      "unaffected_clients": 516,
      "total_queries": 120000,
      "failed_queries": 5200,
      "by_response_code": [
        {
          "response_code": "NOERROR",
          "queries": 114800,
          "clients": 929
        },
        {
          "response_code": "NXDOMAIN",
          "queries": 4100,
          "clients": 390
        }
      ]
    }
  }
}

Get DNS Clients Affected

Parameters

Responses

Related

Get DNS Clients Affected

Parameters

Responses

Related