load-balancing-dns-traffic-by-datacenter

The following shows how to generate the load-balancing-dns-traffic-by-datacenter 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 datacenters.

This report allows you to configure the aggregation interval for each data record. Available interval values are: HOUR, DAY, FIVE_MINUTES.

Business object: fpdomain

Data available for: 90 days

Available metrics

MetricDescription
Data metrics
hitsDNS Requests.
Summary metrics
avg_hitsAverage DNS Requests.
max_hitsMaximum (Peak) DNS Requests.
min_hitsMinimum DNS Requests.
total_hitsTotal DNS Requests.

POST request

POST /reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40: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-26T14: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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of fpdomain 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": [
        "avg_hits",
        "hits",
        "max_hits",
        "min_hits",
        "total_hits"
    ]
}

GET request

GET /reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=avg_hits%2Chits

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40: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-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs an alternative to objectIds, enabling this generates a report that includes all IDs available for the fpdomain 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 fpdomain objectType you want to report on, formatted as a comma-delimited list.
metricsStringavg_hits,​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": "load-balancing-dns-traffic-by-datacenter",
        "version": "2",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "datacenter"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "groupBy",
                "label": "datacenter"
            },
            {
                "name": "hits",
                "label": "DNS Requests"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "data": [
                {
                    "datacenter": "Datacenter_1",
                    "hits": "3451"
                },
                {
                    "datacenter": "Datacenter_5",
                    "hits": "791"
                },
                {
                    "datacenter": "Datacenter_7",
                    "hits": "4750"
                },
                {
                    "datacenter": "Datacenter_11",
                    "hits": "3418"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "datacenter": "Datacenter_1",
                    "hits": "3820"
                },
                {
                    "datacenter": "Datacenter_5",
                    "hits": "124"
                },
                {
                    "datacenter": "Datacenter_7",
                    "hits": "414"
                },
                {
                    "datacenter": "Datacenter_11",
                    "hits": "3306"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "datacenter": "Datacenter_1",
                    "hits": "1935"
                },
                {
                    "datacenter": "Datacenter_5",
                    "hits": "2776"
                },
                {
                    "datacenter": "Datacenter_7",
                    "hits": "4153"
                },
                {
                    "datacenter": "Datacenter_11",
                    "hits": "846"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "datacenter": "Datacenter_1",
                    "hits": "1750"
                },
                {
                    "datacenter": "Datacenter_5",
                    "hits": "477"
                },
                {
                    "datacenter": "Datacenter_7",
                    "hits": "2383"
                },
                {
                    "datacenter": "Datacenter_11",
                    "hits": "808"
                }
            ]
        }
    ],
    "summaryStatistics": {
        "avg_hits": {
            "Datacenter_1": {
                "value": "4773",
                "details": {}
            },
            "Datacenter_5": {
                "value": "1626",
                "details": {}
            },
            "Datacenter_7": {
                "value": "443",
                "details": {}
            },
            "Datacenter_11": {
                "value": "1855",
                "details": {}
            }
        },
        "max_hits": {
            "Datacenter_1": {
                "value": "832",
                "details": {}
            },
            "Datacenter_5": {
                "value": "2526",
                "details": {}
            },
            "Datacenter_7": {
                "value": "820",
                "details": {}
            },
            "Datacenter_11": {
                "value": "3868",
                "details": {}
            }
        },
        "min_hits": {
            "Datacenter_1": {
                "value": "2031",
                "details": {}
            },
            "Datacenter_5": {
                "value": "4662",
                "details": {}
            },
            "Datacenter_7": {
                "value": "3018",
                "details": {}
            },
            "Datacenter_11": {
                "value": "4817",
                "details": {}
            }
        },
        "total_hits": {
            "Datacenter_1": {
                "value": "861",
                "details": {}
            },
            "Datacenter_5": {
                "value": "1916",
                "details": {}
            },
            "Datacenter_7": {
                "value": "3523",
                "details": {}
            },
            "Datacenter_11": {
                "value": "4723",
                "details": {}
            }
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-by-datacenter
version,​2
source,​load-balancing-dns-traffic-by-datacenter/versions/2
groupBy,​startdatetime,​datacenter
start,​2020-06-26T13:40:00Z
end,​2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​fpdomain
objectIds,​55232,​23433,​32433
#METADATA_END

#SUMMARYSTATISTICS_START
avg_hits,Datacenter_1,​4773
avg_hits,Datacenter_5,​1626
avg_hits,Datacenter_7,​443
avg_hits,Datacenter_11,​1855
max_hits,Datacenter_1,​832
max_hits,Datacenter_5,​2526
max_hits,Datacenter_7,​820
max_hits,Datacenter_11,​3868
min_hits,Datacenter_1,​2031
min_hits,Datacenter_5,​4662
min_hits,Datacenter_7,​3018
min_hits,Datacenter_11,​4817
total_hits,Datacenter_1,​861
total_hits,Datacenter_5,​1916
total_hits,Datacenter_7,​3523
total_hits,Datacenter_11,​4723
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​datacenter,​hits
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,Datacenter_1,​3451
2020-06-26T13:40:00Z,Datacenter_5,​791
2020-06-26T13:40:00Z,Datacenter_7,​4750
2020-06-26T13:40:00Z,Datacenter_11,​3418
2020-06-26T13:45:00Z,Datacenter_1,​3820
2020-06-26T13:45:00Z,Datacenter_5,​124
2020-06-26T13:45:00Z,Datacenter_7,​414
2020-06-26T13:45:00Z,Datacenter_11,​3306
2020-06-26T13:50:00Z,Datacenter_1,​1935
2020-06-26T13:50:00Z,Datacenter_5,​2776
2020-06-26T13:50:00Z,Datacenter_7,​4153
2020-06-26T13:50:00Z,Datacenter_11,​846
2020-06-26T13:55:00Z,Datacenter_1,​1750
2020-06-26T13:55:00Z,Datacenter_5,​477
2020-06-26T13:55:00Z,Datacenter_7,​2383
2020-06-26T13:55:00Z,Datacenter_11,​808
#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-by-datacenter report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-by-datacenter",
    "description": "Traffic for a Domain by all datacenters.",
    "businessObjectName": "fpdomain",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "HIERARCHICAL",
    "available": true,
    "metrics": [
        {
            "name": "avg_hits",
            "description": "Average DNS Requests.",
            "label": "Average DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "hits",
            "description": "DNS Requests.",
            "label": "DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "max_hits",
            "description": "Maximum (Peak) DNS Requests.",
            "label": "Maximum DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "min_hits",
            "description": "Minimum DNS Requests.",
            "label": "Minimum DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "total_hits",
            "description": "Total DNS Requests.",
            "label": "Total DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime",
        "datacenter"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-datacenter/versions/2/report-data"
        }
    ]
}