authoritative-dns-availability

The following shows how to generate the authoritative-dns-availability 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

Edge DNS availability.

This report allows you to configure the aggregation interval for each data record. Available interval values are: HOUR, DAY, FIVE_MINUTES.

Business object: contracts

Data available for: 90 days

Available metrics

MetricDescription
Data metrics
avail_pctAvailability percentage.
contract_idThe id of the contract.
Summary metrics
avg_avail_pctAverage availability percentage.
max_avail_pctMaximum (peak) availability percentage.
min_avail_pctMinimum availability percentage.

POST request

POST /reporting-api/v1/reports/authoritative-dns-availability/versions/1/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/authoritative-dns-availability/versions/1/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 contracts 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": [
        "avail_pct",
        "avg_avail_pct",
        "contract_id",
        "max_avail_pct",
        "min_avail_pct"
    ]
}

GET request

GET /reporting-api/v1/reports/authoritative-dns-availability/versions/1/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/authoritative-dns-availability/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=avail_pct%2Cavg_avail_pct

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 contracts 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 contracts objectType you want to report on, formatted as a comma-delimited list.
metricsStringavail_pct,​avg_avail_pctSpecifies 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": "authoritative-dns-availability",
        "version": "1",
        "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": "avail_pct",
                "label": "Availability %"
            },
            {
                "name": "contract_id",
                "label": "Contract"
            }
        ],
        "objectType": "contracts",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "avail_pct": "3548",
            "contract_id": "3-1EBV5F"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "avail_pct": "2113",
            "contract_id": "1-3CV382"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "avail_pct": "4268",
            "contract_id": "Other"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "avail_pct": "13",
            "contract_id": "2-4DW493"
        }
    ],
    "summaryStatistics": {
        "avg_avail_pct": {
            "value": "4179",
            "details": {}
        },
        "max_avail_pct": {
            "value": "4584",
            "details": {}
        },
        "min_avail_pct": {
            "value": "453",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​authoritative-dns-availability
version,​1
source,​authoritative-dns-availability/versions/1
groupBy,​startdatetime
start,​2020-06-26T13:40:00Z
end,​2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​contracts
objectIds,​55232,​23433,​32433
#METADATA_END

#SUMMARYSTATISTICS_START
avg_avail_pct,​4179
max_avail_pct,​4584
min_avail_pct,​453
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​avail_pct,​contract_id
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,3548,​3-1EBV5F
2020-06-26T13:45:00Z,2113,​1-3CV382
2020-06-26T13:50:00Z,4268,Other
2020-06-26T13:55:00Z,13,​2-4DW493
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the authoritative-dns-availability report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/authoritative-dns-availability/versions/1

Status 200 application/json

Response body:

{
    "name": "authoritative-dns-availability",
    "description": "Edge DNS availability.",
    "businessObjectName": "contracts",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "available": true,
    "metrics": [
        {
            "name": "avail_pct",
            "description": "Availability percentage.",
            "label": "Availability %",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "avg_avail_pct",
            "description": "Average availability percentage.",
            "label": "Average Availability %",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "contract_id",
            "description": "The id of the contract.",
            "label": "Contract",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "max_avail_pct",
            "description": "Maximum (peak) availability percentage.",
            "label": "Maximum Availability %",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "min_avail_pct",
            "description": "Minimum availability percentage.",
            "label": "Minimum Availability %",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "HOUR",
        "DAY",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/authoritative-dns-availability/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/authoritative-dns-availability/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/authoritative-dns-availability/versions/1/report-data"
        }
    ]
}