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

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

Liveness 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
isDownTarget Alive = 1 or Target Down = 0
percentAvailableThe average availability for this data point.
startdatetimeEpoch time in milliseconds.
trafficTargetThe Traffic Target.

POST request

POST /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-liveness/versions/4/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-liveness/versions/4/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-property-all-datacenters-liveness/versions/4/report-data?start=2023-05-18&end=2023-05-22&interval=DAY

Query parameters

ParameterTypeSampleDescription
Required
startString2023-05-22T13:55: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.
endString2023-05-22T14:15: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 single fpdomain value you want to report on.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "www.example.com"
    ],
    "metrics": [
        "isDown",
        "percentAvailable",
        "startdatetime",
        "trafficTarget"
    ]
}

GET request

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

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

Query parameters

ParameterTypeSampleDescription
Required
startString2023-05-22T13:55: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.
endString2023-05-22T14:15: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.
Optional
objectIdsStringwww.example.comSpecifies the unique ID for the singlefpdomain objectType you want to report on.
metricsStringisDown,percent‚ÄčAvailableSpecifies 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-liveness",
        "version": "4",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "trafficTarget"
        ],
        "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": "trafficTarget"
            },
            {
                "name": "isDown",
                "label": "Status"
            },
            {
                "name": "percentAvailable",
                "label": "Percent Available"
            },
            {
                "name": "startdatetime",
                "label": "startdatetime"
            },
            {
                "name": "trafficTarget",
                "label": "Traffic Target"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232"
        ]
    },
    "data": [
        {
            "startdatetime": "2023-05-22T13:55:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "isDown": "4740",
                    "percentAvailable": "1177",
                    "startdatetime": "203"
                },
                {
                    "trafficTarget": 54273611,
                    "isDown": "4492",
                    "percentAvailable": "3404",
                    "startdatetime": "1074"
                },
                {
                    "trafficTarget": "Other",
                    "isDown": "3480",
                    "percentAvailable": "1612",
                    "startdatetime": "771"
                },
                {
                    "trafficTarget": 922300,
                    "isDown": "751",
                    "percentAvailable": "4607",
                    "startdatetime": "273"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:00:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "isDown": "4363",
                    "percentAvailable": "4118",
                    "startdatetime": "1059"
                },
                {
                    "trafficTarget": 54273611,
                    "isDown": "1662",
                    "percentAvailable": "630",
                    "startdatetime": "948"
                },
                {
                    "trafficTarget": "Other",
                    "isDown": "2635",
                    "percentAvailable": "1756",
                    "startdatetime": "201"
                },
                {
                    "trafficTarget": 922300,
                    "isDown": "3795",
                    "percentAvailable": "4452",
                    "startdatetime": "562"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:05:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "isDown": "1442",
                    "percentAvailable": "2027",
                    "startdatetime": "116"
                },
                {
                    "trafficTarget": 54273611,
                    "isDown": "3757",
                    "percentAvailable": "3130",
                    "startdatetime": "476"
                },
                {
                    "trafficTarget": "Other",
                    "isDown": "4928",
                    "percentAvailable": "2887",
                    "startdatetime": "891"
                },
                {
                    "trafficTarget": 922300,
                    "isDown": "1148",
                    "percentAvailable": "2970",
                    "startdatetime": "650"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:10:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "isDown": "1404",
                    "percentAvailable": "4515",
                    "startdatetime": "567"
                },
                {
                    "trafficTarget": 54273611,
                    "isDown": "3542",
                    "percentAvailable": "1689",
                    "startdatetime": "1148"
                },
                {
                    "trafficTarget": "Other",
                    "isDown": "14",
                    "percentAvailable": "2395",
                    "startdatetime": "948"
                },
                {
                    "trafficTarget": 922300,
                    "isDown": "1033",
                    "percentAvailable": "1300",
                    "startdatetime": "321"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,load-balancing-dns-traffic-property-all-datacenters-liveness
version,4
source,load-balancing-dns-traffic-property-all-datacenters-liveness/versions/4
groupBy,startdatetime,trafficTarget
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,trafficTarget,isDown,percentAvailable,startdatetime,trafficTarget
#COLUMNS_END

#DATA_START
2023-05-22T13:55:00Z,56273456,4740,1177,203
2023-05-22T13:55:00Z,54273611,4492,3404,1074
2023-05-22T13:55:00Z,Other,3480,1612,771
2023-05-22T13:55:00Z,922300,751,4607,273
2023-05-22T14:00:00Z,56273456,4363,4118,1059
2023-05-22T14:00:00Z,54273611,1662,630,948
2023-05-22T14:00:00Z,Other,2635,1756,201
2023-05-22T14:00:00Z,922300,3795,4452,562
2023-05-22T14:05:00Z,56273456,1442,2027,116
2023-05-22T14:05:00Z,54273611,3757,3130,476
2023-05-22T14:05:00Z,Other,4928,2887,891
2023-05-22T14:05:00Z,922300,1148,2970,650
2023-05-22T14:10:00Z,56273456,1404,4515,567
2023-05-22T14:10:00Z,54273611,3542,1689,1148
2023-05-22T14:10:00Z,Other,14,2395,948
2023-05-22T14:10:00Z,922300,1033,1300,321
#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-liveness 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-liveness/versions/4

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-property-all-datacenters-liveness",
    "description": "Liveness for a Property by all DataCenters.",
    "businessObjectName": "fpdomain",
    "version": 4,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "supportsPagination": false,
    "outputType": "HIERARCHICAL",
    "available": true,
    "metrics": [
        {
            "name": "startdatetime",
            "description": "Epoch time in milliseconds.",
            "label": "startdatetime",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "trafficTarget",
            "description": "The Traffic Target.",
            "label": "Traffic Target",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "isDown",
            "description": "Target Alive = 1 or Target Down = 0",
            "label": "Status",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "percentAvailable",
            "description": "The average availability for this data point.",
            "label": "Percent Available",
            "unit": "COUNT",
            "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-liveness/versions/4"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-liveness/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-liveness/versions/4/report-data"
        }
    ]
}