The following shows how to generate the load-balancing-dns-traffic-property-all-datacenters-demand-summary 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
Summary of Demand for a Property by DataCenter.
Business object: fpdomain
Data available for: 90 days
Available metrics
| Metric | Description | |
|---|---|---|
| Data metrics | ||
actualLoad | Percentage of traffic actually sent for each Traffic Target. | |
alive | Target Alive = 1 or Target Down = 0. | |
hits | The number of requests for the associated URL. | |
requestedLoad | Percentage of traffic requested for each Traffic Target. | |
trafficTarget | The Traffic Target. |
POST request
POST /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3/report-data{?start,end}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3/report-data?start=2023-04-01T00%3A00%3A00Z&end=2023-05-01T00%3A00%3A00Z
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-04-01T00:00: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 | 2023-05-01T00: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. |
JSON request members
| Member | Type | Description |
|---|---|---|
objectIds | Array | Specifies the single fpdomain value you want to report on. |
metrics | Array | The set of desired metrics. If omitted, the report includes all available metrics. |
Request body:
{
"objectIds": [
"www.example.com"
],
"metrics": [
"actualLoad",
"alive",
"hits",
"requestedLoad",
"trafficTarget"
]
}
GET request
GET /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3/report-data{?start,end,objectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3/report-data?start=2023-04-01T00%3A00%3A00Z&end=2023-05-01T00%3A00%3A00Z&objectIds=www.example.com&metrics=actualLoad%2Calive
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-04-01T00:00: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 | 2023-05-01T00: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. |
| Optional | |||
objectIds | String | www.example.com | Specifies the unique ID for the single fpdomain objectType you want to report on. |
metrics | String | actualLoad,alive | 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. |
JSON response
Status 200 application/json
Response body:
{
"metadata": {
"name": "load-balancing-dns-traffic-property-all-datacenters-demand-summary",
"version": "3",
"outputType": "FLAT",
"groupBy": [
"trafficTarget"
],
"start": "2023-04-01T00:00:00Z",
"end": "2023-05-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [],
"columns": [
{
"name": "groupBy",
"label": "trafficTarget"
},
{
"name": "actualLoad",
"label": "Actual Load Percentage"
},
{
"name": "alive",
"label": "Alive"
},
{
"name": "hits",
"label": "DNS Requests"
},
{
"name": "requestedLoad",
"label": "Requested Load"
},
{
"name": "trafficTarget",
"label": "Traffic Target"
}
],
"objectType": "fpdomain",
"objectIds": [
"www.example.com"
]
},
"data": [
{
"trafficTarget": 56273456,
"actualLoad": 21,
"alive": "Down",
"hits": "657",
"requestedLoad": 21
},
{
"trafficTarget": 54273611,
"actualLoad": 3.15,
"alive": "Up",
"hits": "1223",
"requestedLoad": 3.15
},
{
"trafficTarget": "Other",
"actualLoad": "Other",
"alive": "Other",
"hits": "Other",
"requestedLoad": "Other"
},
{
"trafficTarget": 922300,
"actualLoad": 82,
"alive": "Down",
"hits": "900",
"requestedLoad": 82
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,load-balancing-dns-traffic-property-all-datacenters-demand-summary
version,3
source,load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3
groupBy,trafficTarget
start,2023-04-01T00:00:00Z
end,2023-05-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,fpdomain
objectIds,www.example.com
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
trafficTarget,actualLoad,alive,hits,requestedLoad,trafficTarget
#COLUMNS_END
#DATA_START
56273456,21,Down,657,21
54273611,3.15,Up,1223,3.15
Other,Other,Other,Other,Other
922300,82,Down,900,82
#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-summary 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-summary/versions/3
Status 200 application/json
Response body:
{
"name": "load-balancing-dns-traffic-property-all-datacenters-demand-summary",
"description": "Summary of Demand for a Property by DataCenter.",
"businessObjectName": "fpdomain",
"version": 3,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": false,
"supportsPagination": false,
"outputType": "FLAT",
"available": true,
"metrics": [
{
"name": "actualLoad",
"description": "Percentage of traffic actually sent for each Traffic Target.",
"label": "Actual Load Percentage",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "alive",
"description": "Target Alive = 1 or Target Down = 0.",
"label": "Alive",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "hits",
"description": "The number of requests for the associated URL.",
"label": "DNS Requests",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "requestedLoad",
"description": "Percentage of traffic requested for each Traffic Target.",
"label": "Requested Load",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "trafficTarget",
"description": "The Traffic Target.",
"label": "Traffic Target",
"unit": "STRING",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"trafficTarget"
],
"intervals": [
"HOUR",
"DAY",
"FIVE_MINUTES"
],
"dataRetentionDays": 90,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/versions/3"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters-demand-summary/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-summary/versions/3/report-data"
}
]
}