The following shows how to generate the load-balancing-dns-traffic-property-all-datacenters 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
Traffic for a Property by all Datacenters.
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 | ||
hitPercent | DNS Requests per Second. | |
hits | DNS Requests. | |
startdatetime | Epoch time in milliseconds. | |
trafficTarget | The Traffic Target. | |
| Summary metrics | ||
avg_hits | Average DNS Requests. | |
max_hits | Maximum (Peak) DNS Requests. | |
min_hits | Minimum DNS Requests. | |
total_hits | Total DNS Requests. |
POST request
POST /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/4/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/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-all-datacenters/versions/4/report-data?start=2023-05-18&end=2023-05-22&interval=DAY
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-05-22T13:55: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-22T14:15: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 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": [
"avg_hits",
"hitPercent",
"hits",
"max_hits",
"min_hits",
"startdatetime",
"total_hits",
"trafficTarget"
]
}
GET request
GET /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/4/report-data{?start,end,interval,objectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/4/report-data?start=2023-05-22T13%3A55%3A00Z&end=2023-05-22T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=www.example.com&metrics=avg_hits%2ChitPercent
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2023-05-22T13:55: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-22T14:15: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. |
| Optional | |||
objectIds | String | www.example.com | Specifies the unique ID for the single fpdomain objectType you want to report on. |
metrics | String | avg_hits,hitPercent | 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",
"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": "hitPercent",
"label": "DNS Requests Percentage"
},
{
"name": "hits",
"label": "DNS Requests per second"
},
{
"name": "startdatetime",
"label": "startdatetime"
},
{
"name": "trafficTarget",
"label": "Traffic Target"
}
],
"objectType": "fpdomain",
"objectIds": [
"55232"
]
},
"data": [
{
"startdatetime": "2023-05-22T13:55:00Z",
"data": [
{
"trafficTarget": 56273456,
"hitPercent": "0",
"hits": "2844",
"startdatetime": "171"
},
{
"trafficTarget": 54273611,
"hitPercent": "56",
"hits": "3081",
"startdatetime": "557"
},
{
"trafficTarget": "Other",
"hitPercent": "72",
"hits": "4028",
"startdatetime": "401"
},
{
"trafficTarget": 922300,
"hitPercent": "45",
"hits": "3102",
"startdatetime": "762"
}
]
},
{
"startdatetime": "2023-05-22T14:00:00Z",
"data": [
{
"trafficTarget": 56273456,
"hitPercent": "65",
"hits": "2806",
"startdatetime": "1198"
},
{
"trafficTarget": 54273611,
"hitPercent": "59",
"hits": "1349",
"startdatetime": "896"
},
{
"trafficTarget": "Other",
"hitPercent": "42",
"hits": "4011",
"startdatetime": "933"
},
{
"trafficTarget": 922300,
"hitPercent": "37",
"hits": "3666",
"startdatetime": "407"
}
]
},
{
"startdatetime": "2023-05-22T14:05:00Z",
"data": [
{
"trafficTarget": 56273456,
"hitPercent": "34",
"hits": "4444",
"startdatetime": "294"
},
{
"trafficTarget": 54273611,
"hitPercent": "41",
"hits": "1285",
"startdatetime": "777"
},
{
"trafficTarget": "Other",
"hitPercent": "73",
"hits": "3492",
"startdatetime": "848"
},
{
"trafficTarget": 922300,
"hitPercent": "89",
"hits": "3810",
"startdatetime": "29"
}
]
},
{
"startdatetime": "2023-05-22T14:10:00Z",
"data": [
{
"trafficTarget": 56273456,
"hitPercent": "71",
"hits": "594",
"startdatetime": "219"
},
{
"trafficTarget": 54273611,
"hitPercent": "93",
"hits": "776",
"startdatetime": "187"
},
{
"trafficTarget": "Other",
"hitPercent": "32",
"hits": "3381",
"startdatetime": "215"
},
{
"trafficTarget": 922300,
"hitPercent": "54",
"hits": "2729",
"startdatetime": "595"
}
]
}
],
"summaryStatistics": {
"avg_hits": {
"922300": {
"value": "443",
"details": {}
},
"54273611": {
"value": "4103",
"details": {}
},
"56273456": {
"value": "1577",
"details": {}
},
"Other": {
"value": "922",
"details": {}
}
},
"max_hits": {
"922300": {
"value": "3525",
"details": {}
},
"54273611": {
"value": "4801",
"details": {}
},
"56273456": {
"value": "4483",
"details": {}
},
"Other": {
"value": "1047",
"details": {}
}
},
"min_hits": {
"922300": {
"value": "2825",
"details": {}
},
"54273611": {
"value": "3085",
"details": {}
},
"56273456": {
"value": "2446",
"details": {}
},
"Other": {
"value": "1370",
"details": {}
}
},
"total_hits": {
"922300": {
"value": "1738",
"details": {}
},
"54273611": {
"value": "2638",
"details": {}
},
"56273456": {
"value": "1644",
"details": {}
},
"Other": {
"value": "1462",
"details": {}
}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,load-balancing-dns-traffic-property-all-datacenters
version,4
source,load-balancing-dns-traffic-property-all-datacenters/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
avg_hits,922300,443
avg_hits,54273611,4103
avg_hits,56273456,1577
avg_hits,Other,922
max_hits,922300,3525
max_hits,54273611,4801
max_hits,56273456,4483
max_hits,Other,1047
min_hits,922300,2825
min_hits,54273611,3085
min_hits,56273456,2446
min_hits,Other,1370
total_hits,922300,1738
total_hits,54273611,2638
total_hits,56273456,1644
total_hits,Other,1462
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,trafficTarget,hitPercent,hits,startdatetime,trafficTarget
#COLUMNS_END
#DATA_START
2023-05-22T13:55:00Z,56273456,0,2844,171
2023-05-22T13:55:00Z,54273611,56,3081,557
2023-05-22T13:55:00Z,Other,72,4028,401
2023-05-22T13:55:00Z,922300,45,3102,762
2023-05-22T14:00:00Z,56273456,65,2806,1198
2023-05-22T14:00:00Z,54273611,59,1349,896
2023-05-22T14:00:00Z,Other,42,4011,933
2023-05-22T14:00:00Z,922300,37,3666,407
2023-05-22T14:05:00Z,56273456,34,4444,294
2023-05-22T14:05:00Z,54273611,41,1285,777
2023-05-22T14:05:00Z,Other,73,3492,848
2023-05-22T14:05:00Z,922300,89,3810,29
2023-05-22T14:10:00Z,56273456,71,594,219
2023-05-22T14:10:00Z,54273611,93,776,187
2023-05-22T14:10:00Z,Other,32,3381,215
2023-05-22T14:10:00Z,922300,54,2729,595
#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 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/versions/4
Status 200 application/json
Response body:
{
"name": "load-balancing-dns-traffic-property-all-datacenters",
"description": "Traffic for a Property by all Datacenters.",
"businessObjectName": "fpdomain",
"version": 4,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"supportsPagination": false,
"outputType": "HIERARCHICAL",
"available": true,
"metrics": [
{
"name": "avg_hits",
"description": "Average DNS Requests.",
"label": "Average DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "hitPercent",
"description": "DNS Requests per Second.",
"label": "DNS Requests Percentage",
"unit": "RATIO",
"summaryStatistic": false
},
{
"name": "hits",
"description": "DNS Requests.",
"label": "DNS Requests per second",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "max_hits",
"description": "Maximum (Peak) DNS Requests.",
"label": "Maximum DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "min_hits",
"description": "Minimum DNS Requests.",
"label": "Minimum DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "startdatetime",
"description": "Epoch time in milliseconds.",
"label": "startdatetime",
"unit": "MILLISECOND",
"summaryStatistic": false
},
{
"name": "total_hits",
"description": "Total DNS Requests.",
"label": "Total DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"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/versions/4"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-property-all-datacenters/versions/4/report-data"
}
]
}