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

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

Demand for a Property by DataCenter.

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
actualLoadPercentage of traffic actually sent for each Traffic Target.
requestedLoadPercentage of traffic requested for each Traffic Target.
startdatetimeEpoch time in milliseconds.
trafficTargetThe Traffic Target.

POST request

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

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand/versions/4/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": [
        "actualLoad",
        "requestedLoad",
        "startdatetime",
        "trafficTarget"
    ]
}

GET request

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

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

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.
metricsStringactualLoad,​requestedLoadSpecifies 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-demand",
        "version": "4",
        "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": "actualLoad",
                "label": "Actual Load Percentage"
            },
            {
                "name": "requestedLoad",
                "label": "Requested Load"
            },
            {
                "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,
                    "actualLoad": 21,
                    "requestedLoad": 21,
                    "startdatetime": "260"
                },
                {
                    "trafficTarget": 54273611,
                    "actualLoad": 3.15,
                    "requestedLoad": 3.15,
                    "startdatetime": "629"
                },
                {
                    "trafficTarget": "Other",
                    "actualLoad": "Other",
                    "requestedLoad": "Other",
                    "startdatetime": "1137"
                },
                {
                    "trafficTarget": 922300,
                    "actualLoad": 82,
                    "requestedLoad": 82,
                    "startdatetime": "0"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "actualLoad": 21,
                    "requestedLoad": 21,
                    "startdatetime": "226"
                },
                {
                    "trafficTarget": 54273611,
                    "actualLoad": 3.15,
                    "requestedLoad": 3.15,
                    "startdatetime": "7"
                },
                {
                    "trafficTarget": "Other",
                    "actualLoad": "Other",
                    "requestedLoad": "Other",
                    "startdatetime": "746"
                },
                {
                    "trafficTarget": 922300,
                    "actualLoad": 82,
                    "requestedLoad": 82,
                    "startdatetime": "505"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "actualLoad": 21,
                    "requestedLoad": 21,
                    "startdatetime": "242"
                },
                {
                    "trafficTarget": 54273611,
                    "actualLoad": 3.15,
                    "requestedLoad": 3.15,
                    "startdatetime": "505"
                },
                {
                    "trafficTarget": "Other",
                    "actualLoad": "Other",
                    "requestedLoad": "Other",
                    "startdatetime": "34"
                },
                {
                    "trafficTarget": 922300,
                    "actualLoad": 82,
                    "requestedLoad": 82,
                    "startdatetime": "771"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "actualLoad": 21,
                    "requestedLoad": 21,
                    "startdatetime": "934"
                },
                {
                    "trafficTarget": 54273611,
                    "actualLoad": 3.15,
                    "requestedLoad": 3.15,
                    "startdatetime": "666"
                },
                {
                    "trafficTarget": "Other",
                    "actualLoad": "Other",
                    "requestedLoad": "Other",
                    "startdatetime": "103"
                },
                {
                    "trafficTarget": 922300,
                    "actualLoad": 82,
                    "requestedLoad": 82,
                    "startdatetime": "90"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​load-balancing-dns-traffic-property-all-datacenters-demand
version,​4
source,​load-balancing-dns-traffic-property-all-datacenters-demand/versions/4
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

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​trafficTarget,​actualLoad,​requestedLoad,​startdatetime,​trafficTarget
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,56273456,​21,​21,​260
2020-06-26T13:40:00Z,54273611,​3.15,​3.15,​629
2020-06-26T13:40:00Z,Other,Other,Other,​1137
2020-06-26T13:40:00Z,922300,​82,​82,​0
2020-06-26T13:45:00Z,56273456,​21,​21,​226
2020-06-26T13:45:00Z,54273611,​3.15,​3.15,​7
2020-06-26T13:45:00Z,Other,Other,Other,​746
2020-06-26T13:45:00Z,922300,​82,​82,​505
2020-06-26T13:50:00Z,56273456,​21,​21,​242
2020-06-26T13:50:00Z,54273611,​3.15,​3.15,​505
2020-06-26T13:50:00Z,Other,Other,Other,​34
2020-06-26T13:50:00Z,922300,​82,​82,​771
2020-06-26T13:55:00Z,56273456,​21,​21,​934
2020-06-26T13:55:00Z,54273611,​3.15,​3.15,​666
2020-06-26T13:55:00Z,Other,Other,Other,​103
2020-06-26T13:55:00Z,922300,​82,​82,​90
#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-demand 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-demand/versions/4

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-property-all-datacenters-demand",
    "description": "Demand for a Property by DataCenter.",
    "businessObjectName": "fpdomain",
    "version": 4,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "HIERARCHICAL",
    "available": true,
    "metrics": [
        {
            "name": "actualLoad",
            "description": "Percentage of traffic actually sent for each Traffic Target. ",
            "label": "Actual Load Percentage",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "requestedLoad",
            "description": "Percentage of traffic requested for each Traffic Target.",
            "label": "Requested Load",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "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
        }
    ],
    "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-demand/versions/4"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand/versions/4/report-data"
        }
    ]
}