load-balancing-dns-traffic-all-properties

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

MetricDescription
Data metrics
hitsDNS Requests.
startdatetimeEpoch time in milliseconds.

POST request

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

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/2/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
objectIdsStringSpecifies an identifier of a single fpdomain for which you want to see a report.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232"
    ],
    "metrics": [
        "hits",
        "startdatetime"
    ]
}

GET request

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

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/2/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=hits%2Cstartdatetime

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
objectIdsString55232Specifies an identifier of a single fpdomain for which you want to see a report
metricsStringhits,​startdatetimeSpecifies 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": "2",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "hits",
                "label": "DNS Requests"
            },
            {
                "name": "startdatetime",
                "label": "startdatetime"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232"
        ]
    },
    "data": [
        {
            "startdatetime": "326",
            "hits": "900"
        },
        {
            "startdatetime": "822",
            "hits": "1223"
        },
        {
            "startdatetime": "31",
            "hits": "Other"
        },
        {
            "startdatetime": "306",
            "hits": "123"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-all-properties
version,​2
source,​load-balancing-dns-traffic-all-properties/versions/2
groupBy,​startdatetime
start,​2020-05-01T00:00:00Z
end,​2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​fpdomain
objectIds,​55232,​23433,​32433
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​hits,​startdatetime
#COLUMNS_END

#DATA_START
326,​900
822,​1223
31,Other
306,​123
#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/2

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-all-properties",
    "description": "Traffic for a Domain by all properties.",
    "businessObjectName": "fpdomain",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "available": true,
    "metrics": [
        {
            "name": "hits",
            "description": "DNS Requests.",
            "label": "DNS Requests",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "startdatetime",
            "description": "Epoch time in milliseconds.",
            "label": "startdatetime",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-all-properties/versions/2"
        },
        {
            "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/2/report-data"
        }
    ]
}