The following shows how to generate the load-balancing-dns-traffic-error-counts-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
Errors Counts for a Domain by 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 | ||
domain | Domain name. | |
errorCount | The number of errors. | |
property | Property name. |
POST request
POST /reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-by-property/versions/2/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-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-error-counts-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": [
"domain",
"errorCount",
"property"
]
}
GET request
GET /reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-by-property/versions/2/report-data{?start,end,interval,objectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-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=domain%2CerrorCount
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 | domain,errorCount | 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-error-counts-by-property",
"version": "2",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"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": "domain",
"label": "Domain"
},
{
"name": "errorCount",
"label": "Error Count"
},
{
"name": "property",
"label": "Property"
}
],
"objectType": "fpdomain",
"objectIds": [
"www.example.com"
]
},
"data": [
{
"startdatetime": "2023-05-22T13:55:00Z",
"domain": "example.com",
"errorCount": 1,
"property": "Property_1"
},
{
"startdatetime": "2023-05-22T14:00:00Z",
"domain": "testdomain.com",
"errorCount": 478,
"property": "Property_12"
},
{
"startdatetime": "2023-05-22T14:05:00Z",
"domain": "Other",
"errorCount": "Other",
"property": "Other"
},
{
"startdatetime": "2023-05-22T14:10:00Z",
"domain": "testdomain123.com",
"errorCount": 95,
"property": "Property_35"
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,load-balancing-dns-traffic-error-counts-by-property
version,2
source,load-balancing-dns-traffic-error-counts-by-property/versions/2
groupBy,startdatetime
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
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,domain,errorCount,property
#COLUMNS_END
#DATA_START
2023-05-22T13:55:00Z,example.com,1,Property_1
2023-05-22T14:00:00Z,testdomain.com,478,Property_12
2023-05-22T14:05:00Z,Other,Other,Other
2023-05-22T14:10:00Z,testdomain123.com,95,Property_35
#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-error-counts-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-error-counts-by-property/versions/2
Status 200 application/json
Response body:
{
"name": "load-balancing-dns-traffic-error-counts-by-property",
"description": "Errors Counts for a Domain by property.",
"businessObjectName": "fpdomain",
"version": 2,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"supportsPagination": false,
"outputType": "FLAT",
"available": true,
"metrics": [
{
"name": "domain",
"description": "Domain name.",
"label": "Domain",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "errorCount",
"description": "The number of errors.",
"label": "Error Count",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "property",
"description": "Property name.",
"label": "Property",
"unit": "STRING",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime"
],
"intervals": [
"HOUR",
"DAY",
"FIVE_MINUTES"
],
"dataRetentionDays": 90,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-by-property/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-by-property/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-by-property/versions/2/report-data"
}
]
}