load-balancing-dns-traffic-error-counts-by-property

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

MetricDescription
Data metrics
domainDomain name.
errorCountThe number of errors.
propertyProperty 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​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies 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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of fpdomain values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "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,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/load-balancing-dns-traffic-error-counts-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​=domain%2CerrorCount

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: HOUR, DAY, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs 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.
objectIdsString55232,​23433,​32433As 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.
metricsStringdomain,​errorCountSpecifies 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": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00: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": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "domain": "example.com",
            "errorCount": 1,
            "property": "Property_1"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "domain": "testdomain.com",
            "errorCount": 478,
            "property": "Property_12"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "domain": "Other",
            "errorCount": "Other",
            "property": "Other"
        },
        {
            "startdatetime": "2020-06-26T13:55: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,​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

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​domain,​errorCount,​property
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,example.com,​1,Property_1
2020-06-26T13:45:00Z,testdomain.com,​478,Property_12
2020-06-26T13:50:00Z,Other,Other,Other
2020-06-26T13:55: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,
    "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"
        }
    ]
}