urlerrorbytes-by-url report

The following shows how to generate the urlerrorbytes-by-url 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

Returns volume data for requests that returned error responses, by URL.

Business object: cpcode

Data available for: 92 days

Available metrics

Metric Description
Data metrics
errorBytesOffload The volume of requests that returned error responses that was served by Akamai as a percentage of total volume served for given objects and filters.
errorEdgeBytes The volume of requests that returned error responses from Akamai to the end user.
errorOriginBytes The volume of requests that returned error responses from the origin.

Available filters

Filter Type Description
Optional filters
delivery_type Enumeration Distinguishes secure from non-secure traffic.
secure: Secure traffic.
non_secure: Non-secure traffic.
url_contain String URL contains the specified string.
url_end_with String URL ends with the specified string.
url_exact_match String URL is an exact match for the specified string.
url_match String URL matches the specified string.
url_not_contain String URL does not contain the specified string.
url_not_end_with String URL does not end with the specified string.
url_not_match String URL does not match the specified string.
url_not_start_with String URL does not start with the specified string.
url_start_with String URL starts with the specified string.

Sample report

POST /reporting-api/v1/reports/urlerrorbytes-by-url/versions/1/report-data{?start,end}

Sample: /reporting-api/v1/reports/urlerrorbytes-by-url/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z

Object type: Query

Download schema: report-request-schema.json

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 cpcode 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.
filters Map of Arrays Specifies a set of custom filters, with each filter’s name keying an array with each filter’s set of values.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "errorBytesOffload",
        "errorEdgeBytes",
        "errorOriginBytes"
    ],
    "filters": {
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "url_contain": [
            "/shop",
            "/about"
        ],
        "url_end_with": [
            ".html",
            ".jsp"
        ],
        "url_exact_match": [
            "https://www.example.com/shop/index.html",
            "https://www.example.com/about/index.html"
        ],
        "url_match": [
            "https://www.example.com/shop",
            "https://www.example.com/about"
        ],
        "url_not_contain": [
            "/blog",
            "/contact"
        ],
        "url_not_end_with": [
            ".doc",
            ".pdf"
        ],
        "url_not_match": [
            "https://www.example.com/blog",
            "https://www.example.com/contact"
        ],
        "url_not_start_with": [
            "email:",
            "ftp:"
        ],
        "url_start_with": [
            "http:",
            "https:"
        ]
    }
}

GET /reporting-api/v1/reports/urlerrorbytes-by-url/versions/1/report-data{?start,end,objectIds,allObjectIds,metrics,filters}

Sample: /reporting-api/v1/reports/urlerrorbytes-by-url/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=errorBytesOffload%2CerrorEdgeBytes&filters=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure%2Curl_contain%3D%2Fshop%2Curl_contain%3D%2Fabout

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 cpcode 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 cpcode objectType you want to report on, formatted as a comma-delimited list.
metrics String errorBytesOffload,errorEdgeBytes 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.
filters String delivery_type=secure,delivery_type=non-secure,url_contain=/shop,url_contain=/about Specifies criteria to filter the report’s data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "urlerrorbytes-by-url",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "hostname.url"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "delivery_type",
                "values": [
                    "secure",
                    "non-secure"
                ]
            },
            {
                "name": "url_contain",
                "values": [
                    "/shop",
                    "/about"
                ]
            },
            {
                "name": "url_end_with",
                "values": [
                    ".html",
                    ".jsp"
                ]
            },
            {
                "name": "url_exact_match",
                "values": [
                    "https://www.example.com/shop/index.html",
                    "https://www.example.com/about/index.html"
                ]
            },
            {
                "name": "url_match",
                "values": [
                    "https://www.example.com/shop",
                    "https://www.example.com/about"
                ]
            },
            {
                "name": "url_not_contain",
                "values": [
                    "/blog",
                    "/contact"
                ]
            },
            {
                "name": "url_not_end_with",
                "values": [
                    ".pdf",
                    ".js"
                ]
            },
            {
                "name": "url_not_match",
                "values": [
                    "https://www.example.com/blog",
                    "https://www.example.com/contact"
                ]
            },
            {
                "name": "url_not_start_with",
                "values": [
                    "email:",
                    "ftp:"
                ]
            },
            {
                "name": "url_start_with",
                "values": [
                    "http:",
                    "https:"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "hostname.url"
            },
            {
                "name": "errorBytesOffload",
                "label": "Offload"
            },
            {
                "name": "errorEdgeBytes",
                "label": "Edge Bytes"
            },
            {
                "name": "errorOriginBytes",
                "label": "Origin Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "hostname.url": "stream.example.com/subscribe",
            "errorBytesOffload": "56",
            "errorEdgeBytes": "1611",
            "errorOriginBytes": "264"
        },
        {
            "hostname.url": "data.example.com/download/file",
            "errorBytesOffload": "83",
            "errorEdgeBytes": "158",
            "errorOriginBytes": "1050"
        },
        {
            "hostname.url": "stream.example.com/live",
            "errorBytesOffload": "98",
            "errorEdgeBytes": "1070",
            "errorOriginBytes": "4157"
        },
        {
            "hostname.url": "example.com/static/html",
            "errorBytesOffload": "43",
            "errorEdgeBytes": "3204",
            "errorOriginBytes": "2197"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,urlerrorbytes-by-url
version,1
source,urlerrorbytes-by-url/versions/1
groupBy,hostname.url
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
delivery_type,secure,non-secure
url_contain,/shop,/about
url_end_with,.html,.jsp
url_exact_match,https://www.example.com/shop/index.html,https://www.example.com/about/index.html
url_match,https://www.example.com/shop,https://www.example.com/about
url_not_contain,/blog,/contact
url_not_end_with,.pdf,.js
url_not_match,https://www.example.com/blog,https://www.example.com/contact
url_not_start_with,email:,ftp:
url_start_with,http:,https:
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
hostname.url,errorBytesOffload,errorEdgeBytes,errorOriginBytes
#COLUMNS_END

#DATA_START
stream.example.com/subscribe,56,1611,264
data.example.com/download/file,83,158,1050
stream.example.com/live,98,1070,4157
example.com/static/html,43,3204,2197
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/urlerrorbytes-by-url/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "urlerrorbytes-by-url",
    "description": "Returns volume data for requests that returned error responses, by URL.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges ",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "errorBytesOffload",
            "description": "The volume of requests that returned error responses that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Offload",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "errorEdgeBytes",
            "description": "The volume of requests that returned error responses from Akamai to the end user.",
            "label": "Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "errorOriginBytes",
            "description": "The volume of requests that returned error responses from the origin.",
            "label": "Origin Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "hostname.url"
    ],
    "filters": [
        {
            "name": "url_exact_match",
            "type": "string",
            "description": "URL is an exact match for the specified string.",
            "required": false
        },
        {
            "name": "url_not_end_with",
            "type": "string",
            "description": "URL does not end with the specified string.",
            "required": false
        },
        {
            "name": "url_contain",
            "type": "string",
            "description": "URL contains the specified string. ",
            "required": false
        },
        {
            "name": "url_end_with",
            "type": "string",
            "description": "URL ends with the specified string.  ",
            "required": false
        },
        {
            "name": "url_match",
            "type": "string",
            "description": "URL matches the specified string.  ",
            "required": false
        },
        {
            "name": "url_not_contain",
            "type": "string",
            "description": "URL does not contain the specified string. ",
            "required": false
        },
        {
            "name": "url_not_start_with",
            "type": "string",
            "description": "URL does not start with the specified string. ",
            "required": false
        },
        {
            "name": "url_start_with",
            "type": "string",
            "description": "URL starts with the specified string.",
            "required": false
        },
        {
            "name": "url_not_match",
            "type": "string",
            "description": "URL does not match the specified string.",
            "required": false
        },
        {
            "name": "delivery_type",
            "type": "enum",
            "description": "Distinguishes secure from non-secure traffic.",
            "values": [
                {
                    "value": "secure",
                    "description": "Secure traffic. "
                },
                {
                    "value": "non_secure",
                    "description": "Non-secure traffic. "
                }
            ],
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "limit": 500,
    "maxLimit": 25000,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/urlerrorbytes-by-url/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/urlerrorbytes-by-url/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/urlerrorbytes-by-url/versions/1/report-data"
        }
    ]
}