load-balancing-dns-traffic-datacenter-all-properties

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

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-datacenter-all-properties/versions/2/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-datacenter-all-properties/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-datacenter-all-properties/versions/2/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-datacenter-all-properties/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-datacenter-all-properties",
        "version": "2",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "property"
        ],
        "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": "property"
            },
            {
                "name": "hits",
                "label": "DNS Requests"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "data": [
                {
                    "property": "Property_1",
                    "hits": "110"
                },
                {
                    "property": "Property_12",
                    "hits": "1143"
                },
                {
                    "property": "Property_20",
                    "hits": "4477"
                },
                {
                    "property": "Property_35",
                    "hits": "4349"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "property": "Property_1",
                    "hits": "249"
                },
                {
                    "property": "Property_12",
                    "hits": "849"
                },
                {
                    "property": "Property_20",
                    "hits": "4966"
                },
                {
                    "property": "Property_35",
                    "hits": "1230"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "property": "Property_1",
                    "hits": "4077"
                },
                {
                    "property": "Property_12",
                    "hits": "4074"
                },
                {
                    "property": "Property_20",
                    "hits": "1793"
                },
                {
                    "property": "Property_35",
                    "hits": "4258"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "property": "Property_1",
                    "hits": "913"
                },
                {
                    "property": "Property_12",
                    "hits": "1049"
                },
                {
                    "property": "Property_20",
                    "hits": "1699"
                },
                {
                    "property": "Property_35",
                    "hits": "889"
                }
            ]
        }
    ],
    "summaryStatistics": {
        "avg_hits": {
            "Property_1": {
                "value": "359",
                "details": {}
            },
            "Property_12": {
                "value": "4937",
                "details": {}
            },
            "Property_20": {
                "value": "3451",
                "details": {}
            },
            "Property_35": {
                "value": "3069",
                "details": {}
            }
        },
        "max_hits": {
            "Property_1": {
                "value": "756",
                "details": {}
            },
            "Property_12": {
                "value": "2",
                "details": {}
            },
            "Property_20": {
                "value": "123",
                "details": {}
            },
            "Property_35": {
                "value": "4977",
                "details": {}
            }
        },
        "min_hits": {
            "Property_1": {
                "value": "1076",
                "details": {}
            },
            "Property_12": {
                "value": "4209",
                "details": {}
            },
            "Property_20": {
                "value": "3307",
                "details": {}
            },
            "Property_35": {
                "value": "1788",
                "details": {}
            }
        },
        "total_hits": {
            "Property_1": {
                "value": "2490",
                "details": {}
            },
            "Property_12": {
                "value": "4544",
                "details": {}
            },
            "Property_20": {
                "value": "358",
                "details": {}
            },
            "Property_35": {
                "value": "2602",
                "details": {}
            }
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-datacenter-all-properties
version,​2
source,​load-balancing-dns-traffic-datacenter-all-properties/versions/2
groupBy,​startdatetime,​property
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,Property_1,​359
avg_hits,Property_12,​4937
avg_hits,Property_20,​3451
avg_hits,Property_35,​3069
max_hits,Property_1,​756
max_hits,Property_12,​2
max_hits,Property_20,​123
max_hits,Property_35,​4977
min_hits,Property_1,​1076
min_hits,Property_12,​4209
min_hits,Property_20,​3307
min_hits,Property_35,​1788
total_hits,Property_1,​2490
total_hits,Property_12,​4544
total_hits,Property_20,​358
total_hits,Property_35,​2602
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​property,​hits
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,Property_1,​110
2020-06-26T13:40:00Z,Property_12,​1143
2020-06-26T13:40:00Z,Property_20,​4477
2020-06-26T13:40:00Z,Property_35,​4349
2020-06-26T13:45:00Z,Property_1,​249
2020-06-26T13:45:00Z,Property_12,​849
2020-06-26T13:45:00Z,Property_20,​4966
2020-06-26T13:45:00Z,Property_35,​1230
2020-06-26T13:50:00Z,Property_1,​4077
2020-06-26T13:50:00Z,Property_12,​4074
2020-06-26T13:50:00Z,Property_20,​1793
2020-06-26T13:50:00Z,Property_35,​4258
2020-06-26T13:55:00Z,Property_1,​913
2020-06-26T13:55:00Z,Property_12,​1049
2020-06-26T13:55:00Z,Property_20,​1699
2020-06-26T13:55:00Z,Property_35,​889
#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-datacenter-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-datacenter-all-properties/versions/2

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-datacenter-all-properties",
    "description": "Traffic for a Domain by all properties.",
    "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",
        "property"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-datacenter-all-properties/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-datacenter-all-properties/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-datacenter-all-properties/versions/2/report-data"
        }
    ]
}