The following shows how to generate the load-balancing-dns-traffic-by-property 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 Domain by all properties.
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 | ||
hits | DNS Requests. | |
| 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-by-property/versions/2/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2/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-by-property/versions/2/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",
"hits",
"max_hits",
"min_hits",
"total_hits"
]
}
GET request
GET /reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2/report-data{?start,end,interval,objectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2/report-data?start=2023-05-22T13%3A55%3A00Z&end=2023-05-22T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=www.example.com&metrics=avg_hits%2Chits
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,hits | 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-by-property",
"version": "2",
"outputType": "HIERARCHICAL",
"groupBy": [
"startdatetime",
"property"
],
"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": "property"
},
{
"name": "hits",
"label": "DNS Requests"
}
],
"objectType": "fpdomain",
"objectIds": [
"www.example.com"
]
},
"data": [
{
"startdatetime": "2023-05-22T13:55:00Z",
"data": [
{
"property": "Property_1",
"hits": "193"
},
{
"property": "Property_12",
"hits": "1484"
},
{
"property": "Property_20",
"hits": "1624"
},
{
"property": "Property_35",
"hits": "2077"
}
]
},
{
"startdatetime": "2023-05-22T14:00:00Z",
"data": [
{
"property": "Property_1",
"hits": "3040"
},
{
"property": "Property_12",
"hits": "36"
},
{
"property": "Property_20",
"hits": "4758"
},
{
"property": "Property_35",
"hits": "3571"
}
]
},
{
"startdatetime": "2023-05-22T14:05:00Z",
"data": [
{
"property": "Property_1",
"hits": "4882"
},
{
"property": "Property_12",
"hits": "3888"
},
{
"property": "Property_20",
"hits": "4705"
},
{
"property": "Property_35",
"hits": "97"
}
]
},
{
"startdatetime": "2023-05-22T14:10:00Z",
"data": [
{
"property": "Property_1",
"hits": "838"
},
{
"property": "Property_12",
"hits": "3396"
},
{
"property": "Property_20",
"hits": "2903"
},
{
"property": "Property_35",
"hits": "2606"
}
]
}
],
"summaryStatistics": {
"avg_hits": {
"Property_1": {
"value": "2140",
"details": {}
},
"Property_12": {
"value": "3349",
"details": {}
},
"Property_20": {
"value": "3692",
"details": {}
},
"Property_35": {
"value": "3978",
"details": {}
}
},
"max_hits": {
"Property_1": {
"value": "3140",
"details": {}
},
"Property_12": {
"value": "4079",
"details": {}
},
"Property_20": {
"value": "4471",
"details": {}
},
"Property_35": {
"value": "240",
"details": {}
}
},
"min_hits": {
"Property_1": {
"value": "526",
"details": {}
},
"Property_12": {
"value": "1684",
"details": {}
},
"Property_20": {
"value": "3613",
"details": {}
},
"Property_35": {
"value": "4307",
"details": {}
}
},
"total_hits": {
"Property_1": {
"value": "1386",
"details": {}
},
"Property_12": {
"value": "4973",
"details": {}
},
"Property_20": {
"value": "1477",
"details": {}
},
"Property_35": {
"value": "1749",
"details": {}
}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,load-balancing-dns-traffic-by-property
version,2
source,load-balancing-dns-traffic-by-property/versions/2
groupBy,startdatetime,property
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,Property_1,2140
avg_hits,Property_12,3349
avg_hits,Property_20,3692
avg_hits,Property_35,3978
max_hits,Property_1,3140
max_hits,Property_12,4079
max_hits,Property_20,4471
max_hits,Property_35,240
min_hits,Property_1,526
min_hits,Property_12,1684
min_hits,Property_20,3613
min_hits,Property_35,4307
total_hits,Property_1,1386
total_hits,Property_12,4973
total_hits,Property_20,1477
total_hits,Property_35,1749
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,property,hits
#COLUMNS_END
#DATA_START
2023-05-22T13:55:00Z,Property_1,193
2023-05-22T13:55:00Z,Property_12,1484
2023-05-22T13:55:00Z,Property_20,1624
2023-05-22T13:55:00Z,Property_35,2077
2023-05-22T14:00:00Z,Property_1,3040
2023-05-22T14:00:00Z,Property_12,36
2023-05-22T14:00:00Z,Property_20,4758
2023-05-22T14:00:00Z,Property_35,3571
2023-05-22T14:05:00Z,Property_1,4882
2023-05-22T14:05:00Z,Property_12,3888
2023-05-22T14:05:00Z,Property_20,4705
2023-05-22T14:05:00Z,Property_35,97
2023-05-22T14:10:00Z,Property_1,838
2023-05-22T14:10:00Z,Property_12,3396
2023-05-22T14:10:00Z,Property_20,2903
2023-05-22T14:10:00Z,Property_35,2606
#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-by-property report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2
Status 200 application/json
Response body:
{
"name": "load-balancing-dns-traffic-by-property",
"description": "Traffic for a Domain by all properties.",
"businessObjectName": "fpdomain",
"version": 2,
"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": "hits",
"description": "DNS Requests.",
"label": "DNS Requests",
"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": "total_hits",
"description": "Total DNS Requests.",
"label": "Total DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime",
"property"
],
"intervals": [
"HOUR",
"DAY",
"FIVE_MINUTES"
],
"dataRetentionDays": 90,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2/report-data"
}
]
}