load-balancing-dns-traffic-property-all-datacenters

The following shows how to generate the load-balancing-dns-traffic-property-all-datacenters 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 Property 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
hitPercentDNS Requests per Second.
hitsDNS Requests.
startdatetimeEpoch time in milliseconds.
trafficTargetThe Traffic Target.
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-property-all-datacenters/versions/3/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/3/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",
        "hitPercent",
        "hits",
        "max_hits",
        "min_hits",
        "startdatetime",
        "total_hits",
        "trafficTarget"
    ]
}

GET request

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

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

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,​hitPercentSpecifies 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-property-all-datacenters",
        "version": "3",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "trafficTarget"
        ],
        "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": "trafficTarget"
            },
            {
                "name": "hitPercent",
                "label": "DNS Requests Percentage"
            },
            {
                "name": "hits",
                "label": "DNS Requests per second"
            },
            {
                "name": "startdatetime",
                "label": "startdatetime"
            },
            {
                "name": "trafficTarget",
                "label": "Traffic Target"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "hitPercent": "615",
                    "hits": "2819",
                    "startdatetime": "762"
                },
                {
                    "trafficTarget": 54273611,
                    "hitPercent": "150",
                    "hits": "1121",
                    "startdatetime": "56"
                },
                {
                    "trafficTarget": "Other",
                    "hitPercent": "2193",
                    "hits": "4597",
                    "startdatetime": "968"
                },
                {
                    "trafficTarget": 922300,
                    "hitPercent": "4131",
                    "hits": "46",
                    "startdatetime": "827"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "hitPercent": "3264",
                    "hits": "1025",
                    "startdatetime": "486"
                },
                {
                    "trafficTarget": 54273611,
                    "hitPercent": "4660",
                    "hits": "4903",
                    "startdatetime": "766"
                },
                {
                    "trafficTarget": "Other",
                    "hitPercent": "854",
                    "hits": "3921",
                    "startdatetime": "576"
                },
                {
                    "trafficTarget": 922300,
                    "hitPercent": "4045",
                    "hits": "636",
                    "startdatetime": "408"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "hitPercent": "521",
                    "hits": "4372",
                    "startdatetime": "1012"
                },
                {
                    "trafficTarget": 54273611,
                    "hitPercent": "4146",
                    "hits": "3140",
                    "startdatetime": "24"
                },
                {
                    "trafficTarget": "Other",
                    "hitPercent": "1998",
                    "hits": "4258",
                    "startdatetime": "906"
                },
                {
                    "trafficTarget": 922300,
                    "hitPercent": "1790",
                    "hits": "444",
                    "startdatetime": "192"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "hitPercent": "4395",
                    "hits": "1485",
                    "startdatetime": "964"
                },
                {
                    "trafficTarget": 54273611,
                    "hitPercent": "4093",
                    "hits": "4706",
                    "startdatetime": "379"
                },
                {
                    "trafficTarget": "Other",
                    "hitPercent": "2162",
                    "hits": "881",
                    "startdatetime": "263"
                },
                {
                    "trafficTarget": 922300,
                    "hitPercent": "2732",
                    "hits": "976",
                    "startdatetime": "1110"
                }
            ]
        }
    ],
    "summaryStatistics": {
        "avg_hits": {
            "922300": {
                "value": "2320",
                "details": {}
            },
            "54273611": {
                "value": "3060",
                "details": {}
            },
            "56273456": {
                "value": "2650",
                "details": {}
            },
            "Other": {
                "value": "3512",
                "details": {}
            }
        },
        "max_hits": {
            "922300": {
                "value": "454",
                "details": {}
            },
            "54273611": {
                "value": "3497",
                "details": {}
            },
            "56273456": {
                "value": "2398",
                "details": {}
            },
            "Other": {
                "value": "2284",
                "details": {}
            }
        },
        "min_hits": {
            "922300": {
                "value": "2664",
                "details": {}
            },
            "54273611": {
                "value": "1992",
                "details": {}
            },
            "56273456": {
                "value": "1562",
                "details": {}
            },
            "Other": {
                "value": "644",
                "details": {}
            }
        },
        "total_hits": {
            "922300": {
                "value": "1188",
                "details": {}
            },
            "54273611": {
                "value": "475",
                "details": {}
            },
            "56273456": {
                "value": "2704",
                "details": {}
            },
            "Other": {
                "value": "3171",
                "details": {}
            }
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-property-all-datacenters
version,​3
source,​load-balancing-dns-traffic-property-all-datacenters/versions/3
groupBy,​startdatetime,​trafficTarget
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,​922300,​2320
avg_hits,​54273611,​3060
avg_hits,​56273456,​2650
avg_hits,Other,​3512
max_hits,​922300,​454
max_hits,​54273611,​3497
max_hits,​56273456,​2398
max_hits,Other,​2284
min_hits,​922300,​2664
min_hits,​54273611,​1992
min_hits,​56273456,​1562
min_hits,Other,​644
total_hits,​922300,​1188
total_hits,​54273611,​475
total_hits,​56273456,​2704
total_hits,Other,​3171
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​trafficTarget,​hitPercent,​hits,​startdatetime,​trafficTarget
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,56273456,​615,​2819,​762
2020-06-26T13:40:00Z,54273611,​150,​1121,​56
2020-06-26T13:40:00Z,Other,​2193,​4597,​968
2020-06-26T13:40:00Z,922300,​4131,​46,​827
2020-06-26T13:45:00Z,56273456,​3264,​1025,​486
2020-06-26T13:45:00Z,54273611,​4660,​4903,​766
2020-06-26T13:45:00Z,Other,​854,​3921,​576
2020-06-26T13:45:00Z,922300,​4045,​636,​408
2020-06-26T13:50:00Z,56273456,​521,​4372,​1012
2020-06-26T13:50:00Z,54273611,​4146,​3140,​24
2020-06-26T13:50:00Z,Other,​1998,​4258,​906
2020-06-26T13:50:00Z,922300,​1790,​444,​192
2020-06-26T13:55:00Z,56273456,​4395,​1485,​964
2020-06-26T13:55:00Z,54273611,​4093,​4706,​379
2020-06-26T13:55:00Z,Other,​2162,​881,​263
2020-06-26T13:55:00Z,922300,​2732,​976,​1110
#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-property-all-datacenters report as provided in this reference documentation, but available dynamically to your API client application.

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

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-property-all-datacenters",
    "description": "Traffic for a Property by all Datacenters.",
    "businessObjectName": "fpdomain",
    "version": 3,
    "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": "hitPercent",
            "description": "DNS Requests per Second.",
            "label": "DNS Requests Percentage",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "hits",
            "description": "DNS Requests.",
            "label": "DNS Requests per second",
            "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": "startdatetime",
            "description": "Epoch time in milliseconds.",
            "label": "startdatetime",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "total_hits",
            "description": "Total DNS Requests.",
            "label": "Total DNS Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "trafficTarget",
            "description": "The Traffic Target.",
            "label": "Traffic Target",
            "unit": "STRING",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime",
        "trafficTarget"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/3/report-data"
        }
    ]
}