v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Cloud Network Monitoring

Get all aggregated DNS traffic

Get all aggregated DNS traffic.

get/api/v2/network/dns/aggregate

Query parameters

frominteger

Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window is 15 minutes before the to timestamp. If neither from nor to are provided, the query window is [now - 15m, now].

tointeger

Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window is the current time. If neither from nor to are provided, the query window is [now - 15m, now].

group_bystring

Comma-separated list of fields to group DNS traffic by. The server side defaults to network.dns_query if unspecified. server_ungrouped may be used if groups are not desired. The maximum number of group_by(s) is 10.

tagsstring

Comma-separated list of tags to filter DNS traffic by.

querystring

Free-form search query using AND/OR/NOT operators, wildcards, and parentheses. When provided, takes precedence over the tags parameter.

limitinteger

The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "group_bys": [
          {
            "key": "client_service",
            "value": "example-service"
          },
          {
            "key": "network.dns_query",
            "value": "example.com"
          }
        ],
        "metrics": [
          {
            "key": "dns_total_requests",
            "value": 100
          },
          {
            "key": "dns_failures",
            "value": 7
          },
          {
            "key": "dns_successful_responses",
            "value": 93
          },
          {
            "key": "dns_failed_responses",
            "value": 5
          },
          {
            "key": "dns_timeouts",
            "value": 2
          },
          {
            "key": "dns_responses.nxdomain",
            "value": 1
          },
          {
            "key": "dns_responses.servfail",
            "value": 1
          },
          {
            "key": "dns_responses.other",
            "value": 3
          },
          {
            "key": "dns_success_latency_percentile",
            "value": 50
          },
          {
            "key": "dns_failure_latency_percentile",
            "value": 75
          }
        ]
      },
      "id": "client_service:example-service,network.dns_query:example.com",
      "type": "aggregated_dns"
    }
  ]
}