authoritative-dns-traffic-by-zone

The following shows how to generate the authoritative-dns-traffic-by-zone report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides DNS requests/sec and NXDomain response/sec by zone.

Business object: edns

Data available for: 90 days

Available metrics

MetricDescription
Data metrics
percent_nx_domain_responsesThe ratio of NXDOMAIN requests per second to the number of responses per second.
sum_hitsThe number of responses per second.
sum_nxdomainThe number of NXDOMAIN requests per second.
zone_nameThe zone name.

POST request

POST /reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3/report-data{?start,​end}

Sample: /reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp.
endString2020-06-01T00:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of edns values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "percent_nx_domain_responses",
        "sum_hits",
        "sum_nxdomain",
        "zone_name"
    ]
}

GET request

GET /reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3/report-data{?start,​end,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=percent_nx_domain_responses%2Csum_hits

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.
endString2020-06-01T00:00:00ZSpecifies if unavailable reports should be shown.
Optional
allObjectIdsBooleantrueAs an alternative to objectIds, enabling this generates a report that includes all IDs available for the edns objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIdsString55232,​23433,​32433As an alternative to allObjectIds, specifies the set of unique IDs for the edns objectType you want to report on, formatted as a comma-delimited list.
metricsStringpercent_nx_domain_responses,​sum_hitsSpecifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "authoritative-dns-traffic-by-zone",
        "version": "3",
        "outputType": "FLAT",
        "groupBy": [
            "edns"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "edns"
            },
            {
                "name": "percent_nx_domain_responses",
                "label": "% NXDOMAIN Responses"
            },
            {
                "name": "sum_hits",
                "label": "requests"
            },
            {
                "name": "sum_nxdomain",
                "label": "Responses"
            },
            {
                "name": "zone_name",
                "label": "Zone"
            }
        ],
        "objectType": "edns",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "edns": "a28-66.akam.net",
            "percent_nx_domain_responses": "4267",
            "sum_hits": "3661",
            "sum_nxdomain": "1142",
            "zone_name": "a7-66.akam.net"
        },
        {
            "edns": "a16-66.akam.net",
            "percent_nx_domain_responses": "2813",
            "sum_hits": "4961",
            "sum_nxdomain": "4792",
            "zone_name": "a6-66.akam.net"
        },
        {
            "edns": "a7-66.akam.net",
            "percent_nx_domain_responses": "2382",
            "sum_hits": "4488",
            "sum_nxdomain": "181",
            "zone_name": "Other"
        },
        {
            "edns": "a3-66.akam.net",
            "percent_nx_domain_responses": "937",
            "sum_hits": "3246",
            "sum_nxdomain": "3242",
            "zone_name": "a18-66.akam.net"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​authoritative-dns-traffic-by-zone
version,​3
source,​authoritative-dns-traffic-by-zone/versions/3
groupBy,​edns
start,​2020-05-01T00:00:00Z
end,​2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​edns
objectIds,​55232,​23433,​32433
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
edns,​percent_nx_domain_responses,​sum_hits,​sum_nxdomain,​zone_name
#COLUMNS_END

#DATA_START
a28-66.akam.net,​4267,​3661,​1142,​a7-66.akam.net
a16-66.akam.net,​2813,​4961,​4792,​a6-66.akam.net
a7-66.akam.net,​2382,​4488,​181,Other
a3-66.akam.net,​937,​3246,​3242,​a18-66.akam.net
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the authoritative-dns-traffic-by-zone report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3

Status 200 application/json

Response body:

{
    "name": "authoritative-dns-traffic-by-zone",
    "description": "Provides DNS requests/sec and NXDomain response/sec by zone.",
    "businessObjectName": "edns",
    "version": 3,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "available": true,
    "metrics": [
        {
            "name": "percent_nx_domain_responses",
            "description": "The ratio of NXDOMAIN requests per second to the number of responses per second.",
            "label": "% NXDOMAIN Responses",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "sum_hits",
            "description": "The number of responses per second.",
            "label": "requests",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "sum_nxdomain",
            "description": "The number of NXDOMAIN requests per second.",
            "label": "Responses",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "zone_name",
            "description": "The zone name.",
            "label": "Zone",
            "unit": "STRING",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "edns"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/authoritative-dns-traffic-by-zone/versions/3/report-data"
        }
    ]
}