The following shows how to generate the load-balancing-dns-traffic-errors-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 Details for a Domain by property.
Business object: fpdomain
Data available for: 90 days
Available metrics
Metric | Description |
---|---|
Data metrics | |
answeringIp | String representation of an IPv4 or IPv6 address of the customer server. |
datacenter | DataCenter name. |
domain | Domain name. |
duration | The number of seconds the error occurred for. |
errorDescription | The description of the Error. |
errorTime | The time the error occurred. |
property | Property name. |
POST request
POST /reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions/2/report-data{?start,end}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions/2/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2020-05-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 | 2020-06-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 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": [
"answeringIp",
"datacenter",
"domain",
"duration",
"errorDescription",
"errorTime",
"property"
]
}
GET request
GET /reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions/2/report-data{?start,end,objectIds,allObjectIds,metrics}
Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions/2/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=answeringIp%2Cdatacenter
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2020-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. |
end | String | 2020-06-01T00:00:00Z | Specifies if unavailable reports should be shown. |
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 | answeringIp,datacenter | 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-errors-by-property",
"version": "2",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"start": "2020-05-01T00:00:00Z",
"end": "2020-06-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "answeringIp",
"label": "Answering Ip"
},
{
"name": "datacenter",
"label": "DataCenter"
},
{
"name": "domain",
"label": "Domain"
},
{
"name": "duration",
"label": "Duration"
},
{
"name": "errorDescription",
"label": "Error Description"
},
{
"name": "errorTime",
"label": "Error Time"
},
{
"name": "property",
"label": "Property"
}
],
"objectType": "fpdomain",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2019-05-01T00:00:05Z",
"answeringIp": "250.250.250.250",
"datacenter": "Datacenter_1",
"domain": "example.com",
"duration": 5,
"errorDescription": "Bad Request",
"errorTime": "2019-06-01T00:00:10Z",
"property": "Property_1"
},
{
"startdatetime": "2019-05-01T00:00:20Z",
"answeringIp": "250.250.250.251",
"datacenter": "Datacenter_5",
"domain": "testdomain.com",
"duration": 12,
"errorDescription": "Not Found",
"errorTime": "2019-06-01T00:00:20Z",
"property": "Property_12"
},
{
"startdatetime": "2019-05-01T00:00:15Z",
"answeringIp": "Other",
"datacenter": "Other",
"domain": "Other",
"duration": "Other",
"errorDescription": "Other",
"errorTime": "Other",
"property": "Other"
},
{
"startdatetime": "2019-05-01T00:00:25Z",
"answeringIp": "250.250.250.253",
"datacenter": "Datacenter_11",
"domain": "testdomain123.com",
"duration": 20,
"errorDescription": "Forbidden",
"errorTime": "2019-06-01T00:00:00Z",
"property": "Property_35"
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,load-balancing-dns-traffic-errors-by-property
version,2
source,load-balancing-dns-traffic-errors-by-property/versions/2
groupBy,startdatetime
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,fpdomain
objectIds,55232,23433,32433
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,answeringIp,datacenter,domain,duration,errorDescription,errorTime,property
#COLUMNS_END
#DATA_START
2019-05-01T00:00:05Z,250.250.250.250,Datacenter_1,example.com,5,Bad Request,2019-06-01T00:00:10Z,Property_1
2019-05-01T00:00:20Z,250.250.250.251,Datacenter_5,testdomain.com,12,Not Found,2019-06-01T00:00:20Z,Property_12
2019-05-01T00:00:15Z,Other,Other,Other,Other,Other,Other,Other
2019-05-01T00:00:25Z,250.250.250.253,Datacenter_11,testdomain123.com,20,Forbidden,2019-06-01T00:00:00Z,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-errors-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-errors-by-property/versions/2
Status 200 application/json
Response body:
{
"name": "load-balancing-dns-traffic-errors-by-property",
"description": "Errors Details for a Domain by property.",
"businessObjectName": "fpdomain",
"version": 2,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": false,
"outputType": "FLAT",
"available": true,
"metrics": [
{
"name": "answeringIp",
"description": "String representation of an IPv4 or IPv6 address of the customer server.",
"label": "Answering Ip",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "datacenter",
"description": "DataCenter name.",
"label": "DataCenter",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "domain",
"description": "Domain name.",
"label": "Domain",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "duration",
"description": "The number of seconds the error occurred for.",
"label": "Duration",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "errorDescription",
"description": "The description of the Error.",
"label": "Error Description",
"unit": "STRING",
"summaryStatistic": false
},
{
"name": "errorTime",
"description": "The time the error occurred.",
"label": "Error Time",
"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-errors-by-property/versions/2"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/load-balancing-dns-traffic-errors-by-property/versions/2/report-data"
}
]
}