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

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

Metric Description
Data metrics
currentLoad Current of traffic actually sent for each Traffic Target.
loadPercent Load Percentage per Traffic Target.
maxLoad The Maximum traffic expected to be sent for each Traffic Target.
resource Resource.
startdatetime Epoch time in milliseconds.
targetLoad Target/requested traffic requested for each Traffic Target.
totalCurrentLoad Total current load across all Traffic Target for the given interval.
trafficTarget The Traffic Target.

Sample report

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

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies 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.
end String 2020-06-26T14:00:00Z Specifies 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.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.

JSON request members

Member Type Description
objectIds Array Specifies the set of fpdomain values you want to report on.
objectIds Enumeration As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metrics Array The set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "currentLoad",
        "loadPercent",
        "maxLoad",
        "resource",
        "startdatetime",
        "targetLoad",
        "totalCurrentLoad",
        "trafficTarget"
    ]
}

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=55232,23433,32433&metrics=currentLoad%2CloadPercent

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies 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.
end String 2020-06-26T14:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.
Optional
allObjectIds Boolean true As 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.
objectIds String 55232,23433,32433 As 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.
metrics String currentLoad,loadPercent Specifies 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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.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": {}
}

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,55232,23433,32433
#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

Object type: ReportType

Download schema: data-row-schema.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-reports-executor-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/load-balancing-dns-traffic-property-load-feedback/versions/3/report-data"
        }
    ]
}