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

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/4/report-data{?start,end,interval}

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

GET request

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

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

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 single fpdomain objectType you want to report on.
metricsStringcurrentLoad,load​PercentSpecifies 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": "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": "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"
        ]
    },
    "data": [
        {
            "startdatetime": "2023-05-22T13:55:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "267",
                    "loadPercent": "19",
                    "maxLoad": "4963",
                    "resource": "Resource_1",
                    "startdatetime": "338",
                    "targetLoad": "1819",
                    "totalCurrentLoad": "4345"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "2878",
                    "loadPercent": "85",
                    "maxLoad": "1746",
                    "resource": "Resource_2",
                    "startdatetime": "179",
                    "targetLoad": "3026",
                    "totalCurrentLoad": "2795"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "1304",
                    "loadPercent": "32",
                    "maxLoad": "3851",
                    "resource": "Other",
                    "startdatetime": "168",
                    "targetLoad": "2409",
                    "totalCurrentLoad": "3932"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "951",
                    "loadPercent": "22",
                    "maxLoad": "1055",
                    "resource": "Resource_4",
                    "startdatetime": "359",
                    "targetLoad": "1779",
                    "totalCurrentLoad": "4051"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:00:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "509",
                    "loadPercent": "89",
                    "maxLoad": "4218",
                    "resource": "Resource_1",
                    "startdatetime": "8",
                    "targetLoad": "2073",
                    "totalCurrentLoad": "893"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "4717",
                    "loadPercent": "47",
                    "maxLoad": "794",
                    "resource": "Resource_2",
                    "startdatetime": "910",
                    "targetLoad": "1256",
                    "totalCurrentLoad": "4780"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "4725",
                    "loadPercent": "65",
                    "maxLoad": "2525",
                    "resource": "Other",
                    "startdatetime": "305",
                    "targetLoad": "2979",
                    "totalCurrentLoad": "2670"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "2225",
                    "loadPercent": "62",
                    "maxLoad": "3910",
                    "resource": "Resource_4",
                    "startdatetime": "786",
                    "targetLoad": "4020",
                    "totalCurrentLoad": "1600"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:05:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "2481",
                    "loadPercent": "59",
                    "maxLoad": "3575",
                    "resource": "Resource_1",
                    "startdatetime": "199",
                    "targetLoad": "1695",
                    "totalCurrentLoad": "4489"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "3188",
                    "loadPercent": "11",
                    "maxLoad": "2052",
                    "resource": "Resource_2",
                    "startdatetime": "581",
                    "targetLoad": "3876",
                    "totalCurrentLoad": "467"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "2667",
                    "loadPercent": "29",
                    "maxLoad": "529",
                    "resource": "Other",
                    "startdatetime": "824",
                    "targetLoad": "350",
                    "totalCurrentLoad": "4311"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "3109",
                    "loadPercent": "38",
                    "maxLoad": "4423",
                    "resource": "Resource_4",
                    "startdatetime": "1087",
                    "targetLoad": "3846",
                    "totalCurrentLoad": "3444"
                }
            ]
        },
        {
            "startdatetime": "2023-05-22T14:10:00Z",
            "data": [
                {
                    "trafficTarget": 56273456,
                    "currentLoad": "2755",
                    "loadPercent": "18",
                    "maxLoad": "2480",
                    "resource": "Resource_1",
                    "startdatetime": "295",
                    "targetLoad": "2011",
                    "totalCurrentLoad": "3549"
                },
                {
                    "trafficTarget": 54273611,
                    "currentLoad": "1623",
                    "loadPercent": "12",
                    "maxLoad": "3321",
                    "resource": "Resource_2",
                    "startdatetime": "471",
                    "targetLoad": "2486",
                    "totalCurrentLoad": "1330"
                },
                {
                    "trafficTarget": "Other",
                    "currentLoad": "422",
                    "loadPercent": "97",
                    "maxLoad": "3576",
                    "resource": "Other",
                    "startdatetime": "791",
                    "targetLoad": "802",
                    "totalCurrentLoad": "530"
                },
                {
                    "trafficTarget": 922300,
                    "currentLoad": "2334",
                    "loadPercent": "48",
                    "maxLoad": "9",
                    "resource": "Resource_4",
                    "startdatetime": "881",
                    "targetLoad": "2744",
                    "totalCurrentLoad": "2093"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,load-balancing-dns-traffic-property-load-feedback
version,4
source,load-balancing-dns-traffic-property-load-feedback/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,currentLoad,loadPercent,maxLoad,resource,startdatetime,targetLoad,totalCurrentLoad,trafficTarget
#COLUMNS_END

#DATA_START
2023-05-22T13:55:00Z,56273456,267,19,4963,Resource_1,338,1819,4345
2023-05-22T13:55:00Z,54273611,2878,85,1746,Resource_2,179,3026,2795
2023-05-22T13:55:00Z,Other,1304,32,3851,Other,168,2409,3932
2023-05-22T13:55:00Z,922300,951,22,1055,Resource_4,359,1779,4051
2023-05-22T14:00:00Z,56273456,509,89,4218,Resource_1,8,2073,893
2023-05-22T14:00:00Z,54273611,4717,47,794,Resource_2,910,1256,4780
2023-05-22T14:00:00Z,Other,4725,65,2525,Other,305,2979,2670
2023-05-22T14:00:00Z,922300,2225,62,3910,Resource_4,786,4020,1600
2023-05-22T14:05:00Z,56273456,2481,59,3575,Resource_1,199,1695,4489
2023-05-22T14:05:00Z,54273611,3188,11,2052,Resource_2,581,3876,467
2023-05-22T14:05:00Z,Other,2667,29,529,Other,824,350,4311
2023-05-22T14:05:00Z,922300,3109,38,4423,Resource_4,1087,3846,3444
2023-05-22T14:10:00Z,56273456,2755,18,2480,Resource_1,295,2011,3549
2023-05-22T14:10:00Z,54273611,1623,12,3321,Resource_2,471,2486,1330
2023-05-22T14:10:00Z,Other,422,97,3576,Other,791,802,530
2023-05-22T14:10:00Z,922300,2334,48,9,Resource_4,881,2744,2093
#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/4

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": 4,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "supportsPagination": false,
    "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": "RATIO",
            "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/4"
        },
        {
            "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/4/report-data"
        }
    ]
}