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=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES
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": [
"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,allObjectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-by-property/versions/2/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=avg_hits%2Chits
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 | 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": "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": "property"
},
{
"name": "hits",
"label": "DNS Requests"
}
],
"objectType": "fpdomain",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2020-06-26T13:40:00Z",
"data": [
{
"property": "Property_1",
"hits": "4919"
},
{
"property": "Property_12",
"hits": "2415"
},
{
"property": "Property_20",
"hits": "4850"
},
{
"property": "Property_35",
"hits": "531"
}
]
},
{
"startdatetime": "2020-06-26T13:45:00Z",
"data": [
{
"property": "Property_1",
"hits": "747"
},
{
"property": "Property_12",
"hits": "1213"
},
{
"property": "Property_20",
"hits": "4688"
},
{
"property": "Property_35",
"hits": "676"
}
]
},
{
"startdatetime": "2020-06-26T13:50:00Z",
"data": [
{
"property": "Property_1",
"hits": "4931"
},
{
"property": "Property_12",
"hits": "2023"
},
{
"property": "Property_20",
"hits": "2807"
},
{
"property": "Property_35",
"hits": "1634"
}
]
},
{
"startdatetime": "2020-06-26T13:55:00Z",
"data": [
{
"property": "Property_1",
"hits": "2626"
},
{
"property": "Property_12",
"hits": "4667"
},
{
"property": "Property_20",
"hits": "4239"
},
{
"property": "Property_35",
"hits": "2596"
}
]
}
],
"summaryStatistics": {
"avg_hits": {
"Property_1": {
"value": "1815",
"details": {}
},
"Property_12": {
"value": "2158",
"details": {}
},
"Property_20": {
"value": "4953",
"details": {}
},
"Property_35": {
"value": "996",
"details": {}
}
},
"max_hits": {
"Property_1": {
"value": "3171",
"details": {}
},
"Property_12": {
"value": "4596",
"details": {}
},
"Property_20": {
"value": "4088",
"details": {}
},
"Property_35": {
"value": "1711",
"details": {}
}
},
"min_hits": {
"Property_1": {
"value": "4056",
"details": {}
},
"Property_12": {
"value": "2173",
"details": {}
},
"Property_20": {
"value": "819",
"details": {}
},
"Property_35": {
"value": "2151",
"details": {}
}
},
"total_hits": {
"Property_1": {
"value": "3910",
"details": {}
},
"Property_12": {
"value": "3673",
"details": {}
},
"Property_20": {
"value": "2667",
"details": {}
},
"Property_35": {
"value": "4148",
"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,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
avg_hits,Property_1,1815
avg_hits,Property_12,2158
avg_hits,Property_20,4953
avg_hits,Property_35,996
max_hits,Property_1,3171
max_hits,Property_12,4596
max_hits,Property_20,4088
max_hits,Property_35,1711
min_hits,Property_1,4056
min_hits,Property_12,2173
min_hits,Property_20,819
min_hits,Property_35,2151
total_hits,Property_1,3910
total_hits,Property_12,3673
total_hits,Property_20,2667
total_hits,Property_35,4148
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,property,hits
#COLUMNS_END
#DATA_START
2020-06-26T13:40:00Z,Property_1,4919
2020-06-26T13:40:00Z,Property_12,2415
2020-06-26T13:40:00Z,Property_20,4850
2020-06-26T13:40:00Z,Property_35,531
2020-06-26T13:45:00Z,Property_1,747
2020-06-26T13:45:00Z,Property_12,1213
2020-06-26T13:45:00Z,Property_20,4688
2020-06-26T13:45:00Z,Property_35,676
2020-06-26T13:50:00Z,Property_1,4931
2020-06-26T13:50:00Z,Property_12,2023
2020-06-26T13:50:00Z,Property_20,2807
2020-06-26T13:50:00Z,Property_35,1634
2020-06-26T13:55:00Z,Property_1,2626
2020-06-26T13:55:00Z,Property_12,4667
2020-06-26T13:55:00Z,Property_20,4239
2020-06-26T13:55:00Z,Property_35,2596
#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,
"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"
}
]
}