The following shows how to generate the load-balancing-dns-traffic-all-properties 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

Traffic for a Domain by all properties.

Business object: fpdomain

Data available for: 90 days

Available metrics

Metric	Description
Data metrics
`domainName`	The domain name.
`hits`	DNS Requests.
`startdatetime`	Epoch time in milliseconds.

POST request

POST /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data?start=2023-05-22T13%3A55%3A00Z&end=2023-05-22T14%3A15%3A00Z&interval=FIVE_MINUTES

For other granularity, you need to adjust start and end dates:

Sample with longer interval: /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data?start=2023-05-18&end=2023-05-22&interval=DAY

Query parameters

Parameter	Type	Sample	Description
Required
`start`	String	`2020-05-01T00:00:00Z`	Specifies 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.
`end`	String	`2020-06-01T00:00:00Z`	Specifies 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.
`interval`	Enumeration	`FIVE_MINUTES`	The duration of each data record. Available values: `HOUR`, `DAY`, `FIVE_MINUTES`.

JSON request members

Member	Type	Description
`objectIds`	Array	Specifies the single `fpdomain` value you want to report on.
`metrics`	Array	The set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "www.example.com"
    ],
    "metrics": [
        "hits",
        "startdatetime"
    ]
}

GET request

GET /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data{?start,end,interval,objectIds,metrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data?start=2023-05-22T13%3A55%3A00Z&end=2023-05-22T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=www.example.com&metrics=domainName%2Chits

Query parameters

Parameter	Type	Sample	Description
Required
`start`	String	`2023-05-22T13:55:00Z`	Specifies 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.
`end`	String	`2023-05-22T14:15:00Z`	Specifies 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.
`interval`	Enumeration	`FIVE_MINUTES`	The duration of each data record. Available values: `HOUR`, `DAY`, `FIVE_MINUTES`.
Optional
`objectIds`	String	`www.example.com`	Specifies the unique ID for the single `fpdomain` objectType you want to report on.
`metrics`	String	`domainName,hits`	Specifies 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": "load-balancing-dns-traffic-all-properties",
        "version": "3",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "domain"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2023-05-22T13:55:00Z",
        "end": "2023-05-22T14:15:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "groupBy",
                "label": "domain"
            },
            {
                "name": "domainName",
                "label": "Domain Name"
            },
            {
                "name": "hits",
                "label": "DNS Requests"
            },
            {
                "name": "startdatetime",
                "label": "startdatetime"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "www.example.com"
        ]
    },
    "data": [
        {
            "startdatetime": "2023-05-22T13:55:00Z",
            "data": [
                {
                    "domain": "domain_0",
                    "domainName": "example.com",
                    "hits": "4244",
                    "startdatetime": "817"
                },
                {
                    "domain": "domain_1",
                    "domainName": "testdomain.com",
                    "hits": "146",
                    "startdatetime": "368"
                },
                {
                    "domain": "domain_2",
                    "domainName": "Other",
                    "hits": "1947",
                    "startdatetime": "569"
                },
                {
                    "domain": "domain_3",
                    "domainName": "testdomain123.com",
                    "hits": "1705",
                    "startdatetime": "1004"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:00:00Z",
            "data": [
                {
                    "domain": "domain_0",
                    "domainName": "example.com",
                    "hits": "201",
                    "startdatetime": "612"
                },
                {
                    "domain": "domain_1",
                    "domainName": "testdomain.com",
                    "hits": "3792",
                    "startdatetime": "832"
                },
                {
                    "domain": "domain_2",
                    "domainName": "Other",
                    "hits": "681",
                    "startdatetime": "299"
                },
                {
                    "domain": "domain_3",
                    "domainName": "testdomain123.com",
                    "hits": "2257",
                    "startdatetime": "36"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:05:00Z",
            "data": [
                {
                    "domain": "domain_0",
                    "domainName": "example.com",
                    "hits": "3428",
                    "startdatetime": "526"
                },
                {
                    "domain": "domain_1",
                    "domainName": "testdomain.com",
                    "hits": "2531",
                    "startdatetime": "959"
                },
                {
                    "domain": "domain_2",
                    "domainName": "Other",
                    "hits": "2091",
                    "startdatetime": "62"
                },
                {
                    "domain": "domain_3",
                    "domainName": "testdomain123.com",
                    "hits": "1222",
                    "startdatetime": "330"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:10:00Z",
            "data": [
                {
                    "domain": "domain_0",
                    "domainName": "example.com",
                    "hits": "1108",
                    "startdatetime": "1143"
                },
                {
                    "domain": "domain_1",
                    "domainName": "testdomain.com",
                    "hits": "4472",
                    "startdatetime": "989"
                },
                {
                    "domain": "domain_2",
                    "domainName": "Other",
                    "hits": "4397",
                    "startdatetime": "96"
                },
                {
                    "domain": "domain_3",
                    "domainName": "testdomain123.com",
                    "hits": "2156",
                    "startdatetime": "1106"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,load-balancing-dns-traffic-all-properties
version,3
source,load-balancing-dns-traffic-all-properties/versions/3
groupBy,startdatetime,domain
start,2023-05-22T13:55:00Z
end,2023-05-22T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,fpdomain
objectIds,www.example.com
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,domain,domainName,hits,startdatetime
#COLUMNS_END

#DATA_START
2023-05-22T13:55:00Z,domain_0,example.com,4244,817
2023-05-22T13:55:00Z,domain_1,testdomain.com,146,368
2023-05-22T13:55:00Z,domain_2,Other,1947,569
2023-05-22T13:55:00Z,domain_3,testdomain123.com,1705,1004
2023-05-22T14:00:00Z,domain_0,example.com,201,612
2023-05-22T14:00:00Z,domain_1,testdomain.com,3792,832
2023-05-22T14:00:00Z,domain_2,Other,681,299
2023-05-22T14:00:00Z,domain_3,testdomain123.com,2257,36
2023-05-22T14:05:00Z,domain_0,example.com,3428,526
2023-05-22T14:05:00Z,domain_1,testdomain.com,2531,959
2023-05-22T14:05:00Z,domain_2,Other,2091,62
2023-05-22T14:05:00Z,domain_3,testdomain123.com,1222,330
2023-05-22T14:10:00Z,domain_0,example.com,1108,1143
2023-05-22T14:10:00Z,domain_1,testdomain.com,4472,989
2023-05-22T14:10:00Z,domain_2,Other,4397,96
2023-05-22T14:10:00Z,domain_3,testdomain123.com,2156,1106
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-all-properties",
    "description": "Traffic for a Domain by all properties.",
    "businessObjectName": "fpdomain",
    "version": 3,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "supportsPagination": false,
    "outputType": "HIERARCHICAL",
    "available": true,
    "metrics": [
        {
            "name": "hits",
            "description": "DNS Requests.",
            "label": "DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "startdatetime",
            "description": "Epoch time in milliseconds.",
            "label": "startdatetime",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "domainName",
            "description": "The domain name.",
            "label": "Domain Name",
            "unit": "STRING",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime",
        "domain"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/3/report-data"
        }
    ]
}