load-balancing-dns-traffic-property-load-feedback

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

Provides Load Feedback by traffic target for a property.

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
currentLoadCurrent of traffic actually sent for each Traffic Target.
loadPercentLoad Percentage per Traffic Target.
maxLoadThe Maximum traffic expected to be sent for each Traffic Target.
resourceResource.
startdatetimeEpoch time in milliseconds.
targetLoadTarget/requested traffic requested for each Traffic Target.
totalCurrentLoadTotal current load across all Traffic Target for the given interval.
trafficTargetThe Traffic Target.

POST request

POST /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3/report-data{?start,‚Äčend,‚Äčinterval}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/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 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": [
        "www.example.com"
    ],
    "metrics": [
        "currentLoad",
        "loadPercent",
        "maxLoad",
        "resource",
        "startdatetime",
        "targetLoad",
        "totalCurrentLoad",
        "trafficTarget"
    ]
}

GET request

GET /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3/report-data{?start,‚Äčend,‚Äčinterval,‚ÄčobjectIds,‚ÄčallObjectIds,‚Äčmetrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3/report-data?start‚Äč=2020-06-26T13%3A40%3A00Z‚Äč&end‚Äč=2020-06-26T14%3A00%3A00Z‚Äč&interval‚Äč=FIVE_MINUTES‚Äč&objectIds‚Äč=www.example.com‚Äč&metrics‚Äč=currentLoad%2CloadPercent

Query parameters

ParameterTypeSampleDescription
Required
startString2022-06-23T13: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.
endString2022-06-23T14: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 an identifier of a single fpdomain for which you want to see a report.
metricsStringcurrentLoad,‚ÄčloadPercentSpecifies 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-load-feedback",
        "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": "currentLoad",
                "label": "Current Load"
            },
            {
                "name": "loadPercent",
                "label": "Percent load"
            },
            {
                "name": "maxLoad",
                "label": "Max Load"
            },
            {
                "name": "resource",
                "label": "resource"
            },
            {
                "name": "startdatetime",
                "label": "startdatetime"
            },
            {
                "name": "targetLoad",
                "label": "Target Load"
            },
            {
                "name": "totalCurrentLoad",
                "label": "Total Current Load"
            },
            {
                "name": "trafficTarget",
                "label": "Traffic Target"
            }
        ],
        "objectType": "fpdomain",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "2853",
                    "loadPercent": "4096",
                    "maxLoad": "4714",
                    "resource": "Resource_1",
                    "startdatetime": "993",
                    "targetLoad": "2692",
                    "totalCurrentLoad": "2016"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "4804",
                    "loadPercent": "4154",
                    "maxLoad": "3930",
                    "resource": "Resource_2",
                    "startdatetime": "880",
                    "targetLoad": "1204",
                    "totalCurrentLoad": "2012"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "4413",
                    "loadPercent": "3021",
                    "maxLoad": "4871",
                    "resource": "Other",
                    "startdatetime": "845",
                    "targetLoad": "3722",
                    "totalCurrentLoad": "4187"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "4451",
                    "loadPercent": "285",
                    "maxLoad": "3900",
                    "resource": "Resource_4",
                    "startdatetime": "723",
                    "targetLoad": "4198",
                    "totalCurrentLoad": "113"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "2336",
                    "loadPercent": "4067",
                    "maxLoad": "3773",
                    "resource": "Resource_1",
                    "startdatetime": "543",
                    "targetLoad": "2498",
                    "totalCurrentLoad": "374"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "3512",
                    "loadPercent": "4140",
                    "maxLoad": "279",
                    "resource": "Resource_2",
                    "startdatetime": "179",
                    "targetLoad": "3074",
                    "totalCurrentLoad": "110"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "1718",
                    "loadPercent": "3963",
                    "maxLoad": "3046",
                    "resource": "Other",
                    "startdatetime": "837",
                    "targetLoad": "3112",
                    "totalCurrentLoad": "3376"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "3918",
                    "loadPercent": "4941",
                    "maxLoad": "370",
                    "resource": "Resource_4",
                    "startdatetime": "1184",
                    "targetLoad": "3810",
                    "totalCurrentLoad": "280"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "1062",
                    "loadPercent": "3378",
                    "maxLoad": "1779",
                    "resource": "Resource_1",
                    "startdatetime": "749",
                    "targetLoad": "2698",
                    "totalCurrentLoad": "4411"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "1873",
                    "loadPercent": "3053",
                    "maxLoad": "2478",
                    "resource": "Resource_2",
                    "startdatetime": "359",
                    "targetLoad": "90",
                    "totalCurrentLoad": "2936"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "1048",
                    "loadPercent": "3810",
                    "maxLoad": "4563",
                    "resource": "Other",
                    "startdatetime": "15",
                    "targetLoad": "621",
                    "totalCurrentLoad": "1457"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "72",
                    "loadPercent": "1440",
                    "maxLoad": "3753",
                    "resource": "Resource_4",
                    "startdatetime": "389",
                    "targetLoad": "1395",
                    "totalCurrentLoad": "311"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "1888",
                    "loadPercent": "822",
                    "maxLoad": "3880",
                    "resource": "Resource_1",
                    "startdatetime": "205",
                    "targetLoad": "4053",
                    "totalCurrentLoad": "1000"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "3345",
                    "loadPercent": "2284",
                    "maxLoad": "3716",
                    "resource": "Resource_2",
                    "startdatetime": "1050",
                    "targetLoad": "2749",
                    "totalCurrentLoad": "2043"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "1446",
                    "loadPercent": "417",
                    "maxLoad": "2330",
                    "resource": "Other",
                    "startdatetime": "279",
                    "targetLoad": "579",
                    "totalCurrentLoad": "1104"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "4669",
                    "loadPercent": "1763",
                    "maxLoad": "2870",
                    "resource": "Resource_4",
                    "startdatetime": "494",
                    "targetLoad": "629",
                    "totalCurrentLoad": "3458"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,‚Äčload-balancing-dns-traffic-property-load-feedback
version,‚Äč3
source,‚Äčload-balancing-dns-traffic-property-load-feedback/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,‚Äčwww.example.com
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,‚ÄčtrafficTarget,‚ÄčcurrentLoad,‚ÄčloadPercent,‚ÄčmaxLoad,‚Äčresource,‚Äčstartdatetime,‚ÄčtargetLoad,‚ÄčtotalCurrentLoad,‚ÄčtrafficTarget
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,56273456,‚Äč2853,‚Äč4096,‚Äč4714,Resource_1,‚Äč993,‚Äč2692,‚Äč2016
2020-06-26T13:40:00Z,54273611,‚Äč4804,‚Äč4154,‚Äč3930,Resource_2,‚Äč880,‚Äč1204,‚Äč2012
2020-06-26T13:40:00Z,Other,‚Äč4413,‚Äč3021,‚Äč4871,Other,‚Äč845,‚Äč3722,‚Äč4187
2020-06-26T13:40:00Z,922300,‚Äč4451,‚Äč285,‚Äč3900,Resource_4,‚Äč723,‚Äč4198,‚Äč113
2020-06-26T13:45:00Z,56273456,‚Äč2336,‚Äč4067,‚Äč3773,Resource_1,‚Äč543,‚Äč2498,‚Äč374
2020-06-26T13:45:00Z,54273611,‚Äč3512,‚Äč4140,‚Äč279,Resource_2,‚Äč179,‚Äč3074,‚Äč110
2020-06-26T13:45:00Z,Other,‚Äč1718,‚Äč3963,‚Äč3046,Other,‚Äč837,‚Äč3112,‚Äč3376
2020-06-26T13:45:00Z,922300,‚Äč3918,‚Äč4941,‚Äč370,Resource_4,‚Äč1184,‚Äč3810,‚Äč280
2020-06-26T13:50:00Z,56273456,‚Äč1062,‚Äč3378,‚Äč1779,Resource_1,‚Äč749,‚Äč2698,‚Äč4411
2020-06-26T13:50:00Z,54273611,‚Äč1873,‚Äč3053,‚Äč2478,Resource_2,‚Äč359,‚Äč90,‚Äč2936
2020-06-26T13:50:00Z,Other,‚Äč1048,‚Äč3810,‚Äč4563,Other,‚Äč15,‚Äč621,‚Äč1457
2020-06-26T13:50:00Z,922300,‚Äč72,‚Äč1440,‚Äč3753,Resource_4,‚Äč389,‚Äč1395,‚Äč311
2020-06-26T13:55:00Z,56273456,‚Äč1888,‚Äč822,‚Äč3880,Resource_1,‚Äč205,‚Äč4053,‚Äč1000
2020-06-26T13:55:00Z,54273611,‚Äč3345,‚Äč2284,‚Äč3716,Resource_2,‚Äč1050,‚Äč2749,‚Äč2043
2020-06-26T13:55:00Z,Other,‚Äč1446,‚Äč417,‚Äč2330,Other,‚Äč279,‚Äč579,‚Äč1104
2020-06-26T13:55:00Z,922300,‚Äč4669,‚Äč1763,‚Äč2870,Resource_4,‚Äč494,‚Äč629,‚Äč3458
#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-load-feedback 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-load-feedback/versions/3

Status 200 application/json

Response body:

{
    "name": "load-balancing-dns-traffic-property-load-feedback",
    "description": "Provides Load Feedback by traffic target for a property.",
    "businessObjectName": "fpdomain",
    "version": 3,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "HIERARCHICAL",
    "available": true,
    "metrics": [
        {
            "name": "currentLoad",
            "description": "Current of traffic actually sent for each Traffic Target.",
            "label": "Current Load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "loadPercent",
            "description": "Load Percentage per Traffic Target.",
            "label": "Percent load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "maxLoad",
            "description": "The Maximum traffic expected to be sent for each Traffic Target.",
            "label": "Max Load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "resource",
            "description": "Resource.",
            "label": "resource",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "startdatetime",
            "description": "Epoch time in milliseconds.",
            "label": "startdatetime",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "targetLoad",
            "description": "Target/requested traffic requested for each Traffic Target.",
            "label": "Target Load",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "totalCurrentLoad",
            "description": "Total current load across all Traffic Target for the given interval.",
            "label": "Total Current Load",
            "unit": "COUNT",
            "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-load-feedback/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3/report-data"
        }
    ]
}