urlbytes-by-time report

The following shows how to generate the urlbytes-by-time 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 URL volume data over time

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

Business object: cpcode

Data available for: 92 days

Available metrics

Metric Description
Data metrics
allBytesOffload The total volume that was served by Akamai as a percentage of total volume served for given objects and filters.
allBytesOffloadAvg The average volume that was served by Akamai as a percentage of total volume served for given objects and filters.
allBytesOffloadMax The highest volume that was served by Akamai as a percentage of total volume served for given objects and filters.
allBytesOffloadMin The lowest volume that was served by Akamai as a percentage of total volume served for given objects and filters.
allBytesOffloadSlope Represents the overall change in the volume that was served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.
allEdgeBitsPerSecond The total rate of volume delivered from Akamai to end user.
allEdgeBitsPerSecondMax The highest rate of volume delivered from Akamai to end user.
allEdgeBitsPerSecondMin The lowest rate of volume delivered from Akamai to end user.
allEdgeBytesSlope Represents the overall change in the volume that was served by Akamai to the end user, a positive number if increasing or a negative number if decreasing.
allEdgeBytesTotal The total volume delivered from Akamai to end user.
allOriginBitsPerSecond The total rate of volume delivered from the origin.
allOriginBitsPerSecondMax The highest rate of volume delivered from the origin.
allOriginBitsPerSecondMin The lowest rate of volume delivered from the origin.
allOriginBytesSlope Represents the overall change in the volume delivered by the origin, a positive number if increasing or a negative number if decreasing.
allOriginBytesTotal The total rate of volume delivered from the origin.
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.
errorBytesOffloadAvg The average volume of requests that returned error responses that was served by Akamai as a percentage of total volume served for given objects and filters.
errorBytesOffloadMax The highest volume of requests that returned error responses that was served by Akamai as a percentage of total volume served for given objects and filters.
errorBytesOffloadMin The lowest volume of requests that returned error responses that was served by Akamai as a percentage of total volume served for given objects and filters.
errorBytesOffloadSlope Represents the overall change in the volume of requests that returned error responses served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.
errorEdgeBitsPerSecond The rate of requests that returned error responses that was served by Akamai.
errorEdgeBitsPerSecondMax The highest rate of requests that returned error responses that was served by Akamai.
errorEdgeBitsPerSecondMin The lowest rate of requests that returned error responses that was served by Akamai.
errorEdgeBytesSlope Represents the overall change in the volume of requests that returned error responses served by Akamai, a positive number if increasing or a negative number if decreasing.
errorEdgeBytesTotal The total volume of requests that returned error responses that was served by Akamai.
errorOriginBitsPerSecond The rate of requests that returned error responses that was served by the origin.
errorOriginBitsPerSecondMax The highest rate of requests that returned error responses that was served by the origin.
errorOriginBitsPerSecondMin The lowest rate of requests that returned error responses that was served by the origin.
errorOriginBytesSlope Represents the overall change in the volume of requests that returned error responses served by the origin, a positive number if increasing or a negative number if decreasing.
errorOriginBytesTotal The total volume of requests that returned error responses that was served by the origin.
successBytesOffload The volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.
successBytesOffloadAvg The average volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.
successBytesOffloadMax The highest volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.
successBytesOffloadMin The lowest volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.
successBytesOffloadSlope Represents the overall change in the volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.
successEdgeBitsPerSecond The rate of successful requests delivered from Akamai to the end user.
successEdgeBitsPerSecondMax The highest rate of successful requests delivered from Akamai to the end user.
successEdgeBitsPerSecondMin The lowest rate of successful requests delivered from Akamai to the end user.
successEdgeBytesSlope Represents the overall change in the volume for successful requests that was served by Akamai to the end user, a positive number if increasing or a negative number if decreasing.
successEdgeBytesTotal The total rate of successful requests delivered from Akamai to the end user.
successOriginBitsPerSecond The rate of successful requests delivered from the origin.
successOriginBitsPerSecondMax The highest rate of successful requests delivered from the origin.
successOriginBitsPerSecondMin The lowest rate of successful requests delivered from the origin.
successOriginBytesSlope Represents the overall change in the volume for successful requests that was served by the origin, a positive number if increasing or a negative number if decreasing.
successOriginBytesTotal The total volume of successful requests delivered 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/urlbytes-by-time/versions/1/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/urlbytes-by-time/versions/1/report-data?start=2019-10-04T00%3A00%3A00Z&end=2019-10-08T00%3A00%3A00Z&interval=DAY

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2019-10-04T00: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 2019-10-08T00:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration DAY The duration of each data record. Available values: MONTH, WEEK, DAY.

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": [
        "allBytesOffload",
        "allBytesOffloadAvg",
        "allBytesOffloadMax",
        "allBytesOffloadMin",
        "allBytesOffloadSlope",
        "allEdgeBitsPerSecond",
        "allEdgeBitsPerSecondMax",
        "allEdgeBitsPerSecondMin",
        "allEdgeBytesSlope",
        "allEdgeBytesTotal",
        "allOriginBitsPerSecond",
        "allOriginBitsPerSecondMax",
        "allOriginBitsPerSecondMin",
        "allOriginBytesSlope",
        "allOriginBytesTotal",
        "errorBytesOffload",
        "errorBytesOffloadAvg",
        "errorBytesOffloadMax",
        "errorBytesOffloadMin",
        "errorBytesOffloadSlope",
        "errorEdgeBitsPerSecond",
        "errorEdgeBitsPerSecondMax",
        "errorEdgeBitsPerSecondMin",
        "errorEdgeBytesSlope",
        "errorEdgeBytesTotal",
        "errorOriginBitsPerSecond",
        "errorOriginBitsPerSecondMax",
        "errorOriginBitsPerSecondMin",
        "errorOriginBytesSlope",
        "errorOriginBytesTotal",
        "successBytesOffload",
        "successBytesOffloadAvg",
        "successBytesOffloadMax",
        "successBytesOffloadMin",
        "successBytesOffloadSlope",
        "successEdgeBitsPerSecond",
        "successEdgeBitsPerSecondMax",
        "successEdgeBitsPerSecondMin",
        "successEdgeBytesSlope",
        "successEdgeBytesTotal",
        "successOriginBitsPerSecond",
        "successOriginBitsPerSecondMax",
        "successOriginBitsPerSecondMin",
        "successOriginBytesSlope",
        "successOriginBytesTotal"
    ],
    "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",
            ".css"
        ],
        "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/urlbytes-by-time/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}

Sample: /reporting-api/v1/reports/urlbytes-by-time/versions/1/report-data?start=2019-10-04T00%3A00%3A00Z&end=2019-10-08T00%3A00%3A00Z&interval=DAY&objectIds=55232,23433,32433&metrics=allBytesOffload%2CallBytesOffloadAvg&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 2019-10-04T00: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 2019-10-08T00:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration DAY The duration of each data record. Available values: MONTH, WEEK, DAY.
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 allBytesOffload,allBytesOffloadAvg 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": "urlbytes-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "date_id"
        ],
        "interval": "DAY",
        "start": "2019-10-04T00:00:00Z",
        "end": "2019-10-08T00: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": "date_id"
            },
            {
                "name": "allBytesOffload",
                "label": "Offloaded Bytes"
            },
            {
                "name": "allBytesOffloadAvg",
                "label": "Average Bytes Offload"
            },
            {
                "name": "allBytesOffloadMax",
                "label": "Bytes Offload Maximum"
            },
            {
                "name": "allBytesOffloadMin",
                "label": "Bytes Offload Minimum"
            },
            {
                "name": "allBytesOffloadSlope",
                "label": "Bytes Offload  Slope"
            },
            {
                "name": "allEdgeBitsPerSecond",
                "label": "Edge Bits/Sec"
            },
            {
                "name": "allEdgeBitsPerSecondMax",
                "label": "Edge Bits/Sec Maximum"
            },
            {
                "name": "allEdgeBitsPerSecondMin",
                "label": "Edge Bits/Sec Minimum"
            },
            {
                "name": "allEdgeBytesSlope",
                "label": "Edge Bytes Slope"
            },
            {
                "name": "allEdgeBytesTotal",
                "label": "Total Edge Bytes"
            },
            {
                "name": "allOriginBitsPerSecond",
                "label": "Origin Bits/Sec"
            },
            {
                "name": "allOriginBitsPerSecondMax",
                "label": "Origin Bits/Sec Maximum"
            },
            {
                "name": "allOriginBitsPerSecondMin",
                "label": "Origin Bits/Sec Minimum"
            },
            {
                "name": "allOriginBytesSlope",
                "label": " Origin Bytes Slope"
            },
            {
                "name": "allOriginBytesTotal",
                "label": "Total Origin Bytes"
            },
            {
                "name": "errorBytesOffload",
                "label": "Offloaded Bytes"
            },
            {
                "name": "errorBytesOffloadAvg",
                "label": "Average Bytes Offload"
            },
            {
                "name": "errorBytesOffloadMax",
                "label": "Bytes Offload Maximum"
            },
            {
                "name": "errorBytesOffloadMin",
                "label": "Bytes Offload Minimum"
            },
            {
                "name": "errorBytesOffloadSlope",
                "label": "Bytes Offload  Slope"
            },
            {
                "name": "errorEdgeBitsPerSecond",
                "label": "Edge Bits/Sec"
            },
            {
                "name": "errorEdgeBitsPerSecondMax",
                "label": "Edge Bits/Sec Maximum"
            },
            {
                "name": "errorEdgeBitsPerSecondMin",
                "label": "Edge Bits/Sec Minimum"
            },
            {
                "name": "errorEdgeBytesSlope",
                "label": "Edge Bytes Slope"
            },
            {
                "name": "errorEdgeBytesTotal",
                "label": "Total Edge Bytes"
            },
            {
                "name": "errorOriginBitsPerSecond",
                "label": "Origin Bits/Sec"
            },
            {
                "name": "errorOriginBitsPerSecondMax",
                "label": "Origin Bits/Sec Maximum"
            },
            {
                "name": "errorOriginBitsPerSecondMin",
                "label": "Origin Bits/Sec Minimum"
            },
            {
                "name": "errorOriginBytesSlope",
                "label": "Origin Bytes Slope"
            },
            {
                "name": "errorOriginBytesTotal",
                "label": "Total Origin Bytes"
            },
            {
                "name": "successBytesOffload",
                "label": "Offloaded Bytes"
            },
            {
                "name": "successBytesOffloadAvg",
                "label": "Average Bytes Offload"
            },
            {
                "name": "successBytesOffloadMax",
                "label": "Bytes Offload Maximum"
            },
            {
                "name": "successBytesOffloadMin",
                "label": "Bytes Offload Minimum"
            },
            {
                "name": "successBytesOffloadSlope",
                "label": "Bytes Offload  Slope"
            },
            {
                "name": "successEdgeBitsPerSecond",
                "label": "Edge Bits/Sec"
            },
            {
                "name": "successEdgeBitsPerSecondMax",
                "label": "Edge Bits/Sec Maximum"
            },
            {
                "name": "successEdgeBitsPerSecondMin",
                "label": "Edge Bits/Sec Minimum"
            },
            {
                "name": "successEdgeBytesSlope",
                "label": "Edge Bytes Slope"
            },
            {
                "name": "successEdgeBytesTotal",
                "label": "Total Edge Bytes"
            },
            {
                "name": "successOriginBitsPerSecond",
                "label": "Origin Bits/Sec"
            },
            {
                "name": "successOriginBitsPerSecondMax",
                "label": "Origin Bits/Sec Maximum"
            },
            {
                "name": "successOriginBitsPerSecondMin",
                "label": "Origin Bits/Sec Minimum"
            },
            {
                "name": "successOriginBytesSlope",
                "label": "Origin Bytes Slope"
            },
            {
                "name": "successOriginBytesTotal",
                "label": "Total Origin Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "date_id": "2019-10-04T00:00:00Z",
            "allBytesOffload": "93",
            "allBytesOffloadAvg": "47",
            "allBytesOffloadMax": "82",
            "allBytesOffloadMin": "75",
            "allBytesOffloadSlope": "1820",
            "allEdgeBitsPerSecond": "1248.036144",
            "allEdgeBitsPerSecondMax": "834.894292",
            "allEdgeBitsPerSecondMin": "513.959762",
            "allEdgeBytesSlope": "2057",
            "allEdgeBytesTotal": "1290",
            "allOriginBitsPerSecond": "884.969329",
            "allOriginBitsPerSecondMax": "1636.881142",
            "allOriginBitsPerSecondMin": "852.014964",
            "allOriginBytesSlope": "310",
            "allOriginBytesTotal": "4864",
            "errorBytesOffload": "84",
            "errorBytesOffloadAvg": "74",
            "errorBytesOffloadMax": "29",
            "errorBytesOffloadMin": "15",
            "errorBytesOffloadSlope": "415",
            "errorEdgeBitsPerSecond": "3215.114656",
            "errorEdgeBitsPerSecondMax": "926.499859",
            "errorEdgeBitsPerSecondMin": "2419.656089",
            "errorEdgeBytesSlope": "3446",
            "errorEdgeBytesTotal": "2309",
            "errorOriginBitsPerSecond": "1425.787011",
            "errorOriginBitsPerSecondMax": "2470.837585",
            "errorOriginBitsPerSecondMin": "3622.172997",
            "errorOriginBytesSlope": "2304",
            "errorOriginBytesTotal": "2943",
            "successBytesOffload": "78",
            "successBytesOffloadAvg": "6",
            "successBytesOffloadMax": "5",
            "successBytesOffloadMin": "15",
            "successBytesOffloadSlope": "1688",
            "successEdgeBitsPerSecond": "4571.489257",
            "successEdgeBitsPerSecondMax": "1945.193079",
            "successEdgeBitsPerSecondMin": "4826.527438",
            "successEdgeBytesSlope": "2069",
            "successEdgeBytesTotal": "1226",
            "successOriginBitsPerSecond": "810.991346",
            "successOriginBitsPerSecondMax": "300.47834",
            "successOriginBitsPerSecondMin": "3863.596406",
            "successOriginBytesSlope": "4524",
            "successOriginBytesTotal": "1892"
        },
        {
            "date_id": "2019-10-05T00:00:00Z",
            "allBytesOffload": "32",
            "allBytesOffloadAvg": "91",
            "allBytesOffloadMax": "84",
            "allBytesOffloadMin": "62",
            "allBytesOffloadSlope": "2948",
            "allEdgeBitsPerSecond": "3904.097101",
            "allEdgeBitsPerSecondMax": "4010.036458",
            "allEdgeBitsPerSecondMin": "2642.378701",
            "allEdgeBytesSlope": "2543",
            "allEdgeBytesTotal": "2666",
            "allOriginBitsPerSecond": "468.419659",
            "allOriginBitsPerSecondMax": "1076.859158",
            "allOriginBitsPerSecondMin": "2165.272542",
            "allOriginBytesSlope": "2080",
            "allOriginBytesTotal": "2742",
            "errorBytesOffload": "55",
            "errorBytesOffloadAvg": "20",
            "errorBytesOffloadMax": "35",
            "errorBytesOffloadMin": "53",
            "errorBytesOffloadSlope": "3413",
            "errorEdgeBitsPerSecond": "4952.45134",
            "errorEdgeBitsPerSecondMax": "4058.295713",
            "errorEdgeBitsPerSecondMin": "3097.306194",
            "errorEdgeBytesSlope": "1246",
            "errorEdgeBytesTotal": "2062",
            "errorOriginBitsPerSecond": "1763.647414",
            "errorOriginBitsPerSecondMax": "4081.840353",
            "errorOriginBitsPerSecondMin": "1228.734693",
            "errorOriginBytesSlope": "1633",
            "errorOriginBytesTotal": "219",
            "successBytesOffload": "24",
            "successBytesOffloadAvg": "49",
            "successBytesOffloadMax": "18",
            "successBytesOffloadMin": "89",
            "successBytesOffloadSlope": "1141",
            "successEdgeBitsPerSecond": "1459.023624",
            "successEdgeBitsPerSecondMax": "3978.705048",
            "successEdgeBitsPerSecondMin": "606.357068",
            "successEdgeBytesSlope": "2265",
            "successEdgeBytesTotal": "2202",
            "successOriginBitsPerSecond": "2332.424088",
            "successOriginBitsPerSecondMax": "3264.705385",
            "successOriginBitsPerSecondMin": "534.248991",
            "successOriginBytesSlope": "748",
            "successOriginBytesTotal": "4405"
        },
        {
            "date_id": "2019-10-06T00:00:00Z",
            "allBytesOffload": "18",
            "allBytesOffloadAvg": "49",
            "allBytesOffloadMax": "73",
            "allBytesOffloadMin": "77",
            "allBytesOffloadSlope": "4419",
            "allEdgeBitsPerSecond": "2888.544221",
            "allEdgeBitsPerSecondMax": "1451.866276",
            "allEdgeBitsPerSecondMin": "4693.991248",
            "allEdgeBytesSlope": "4357",
            "allEdgeBytesTotal": "1610",
            "allOriginBitsPerSecond": "1513.532169",
            "allOriginBitsPerSecondMax": "854.149614",
            "allOriginBitsPerSecondMin": "2372.169375",
            "allOriginBytesSlope": "2887",
            "allOriginBytesTotal": "759",
            "errorBytesOffload": "92",
            "errorBytesOffloadAvg": "51",
            "errorBytesOffloadMax": "77",
            "errorBytesOffloadMin": "83",
            "errorBytesOffloadSlope": "998",
            "errorEdgeBitsPerSecond": "4920.682537",
            "errorEdgeBitsPerSecondMax": "565.856423",
            "errorEdgeBitsPerSecondMin": "1310.453488",
            "errorEdgeBytesSlope": "1470",
            "errorEdgeBytesTotal": "2588",
            "errorOriginBitsPerSecond": "468.077072",
            "errorOriginBitsPerSecondMax": "1865.455538",
            "errorOriginBitsPerSecondMin": "4362.958896",
            "errorOriginBytesSlope": "2381",
            "errorOriginBytesTotal": "821",
            "successBytesOffload": "91",
            "successBytesOffloadAvg": "28",
            "successBytesOffloadMax": "31",
            "successBytesOffloadMin": "66",
            "successBytesOffloadSlope": "4375",
            "successEdgeBitsPerSecond": "1236.567711",
            "successEdgeBitsPerSecondMax": "4328.273188",
            "successEdgeBitsPerSecondMin": "686.815402",
            "successEdgeBytesSlope": "2025",
            "successEdgeBytesTotal": "11",
            "successOriginBitsPerSecond": "3127.207038",
            "successOriginBitsPerSecondMax": "4749.236336",
            "successOriginBitsPerSecondMin": "487.160231",
            "successOriginBytesSlope": "1109",
            "successOriginBytesTotal": "4162"
        },
        {
            "date_id": "2019-10-07T00:00:00Z",
            "allBytesOffload": "32",
            "allBytesOffloadAvg": "32",
            "allBytesOffloadMax": "86",
            "allBytesOffloadMin": "61",
            "allBytesOffloadSlope": "2227",
            "allEdgeBitsPerSecond": "3301.841841",
            "allEdgeBitsPerSecondMax": "1255.822636",
            "allEdgeBitsPerSecondMin": "1561.985002",
            "allEdgeBytesSlope": "4685",
            "allEdgeBytesTotal": "1736",
            "allOriginBitsPerSecond": "2446.403628",
            "allOriginBitsPerSecondMax": "1248.427283",
            "allOriginBitsPerSecondMin": "132.940419",
            "allOriginBytesSlope": "2966",
            "allOriginBytesTotal": "3832",
            "errorBytesOffload": "44",
            "errorBytesOffloadAvg": "87",
            "errorBytesOffloadMax": "70",
            "errorBytesOffloadMin": "74",
            "errorBytesOffloadSlope": "152",
            "errorEdgeBitsPerSecond": "26.573552",
            "errorEdgeBitsPerSecondMax": "1875.682008",
            "errorEdgeBitsPerSecondMin": "2985.211032",
            "errorEdgeBytesSlope": "3301",
            "errorEdgeBytesTotal": "360",
            "errorOriginBitsPerSecond": "4642.742236",
            "errorOriginBitsPerSecondMax": "1019.891553",
            "errorOriginBitsPerSecondMin": "800.171176",
            "errorOriginBytesSlope": "2842",
            "errorOriginBytesTotal": "4666",
            "successBytesOffload": "83",
            "successBytesOffloadAvg": "23",
            "successBytesOffloadMax": "57",
            "successBytesOffloadMin": "41",
            "successBytesOffloadSlope": "803",
            "successEdgeBitsPerSecond": "604.961692",
            "successEdgeBitsPerSecondMax": "2846.712771",
            "successEdgeBitsPerSecondMin": "1522.409729",
            "successEdgeBytesSlope": "2441",
            "successEdgeBytesTotal": "2301",
            "successOriginBitsPerSecond": "3304.687434",
            "successOriginBitsPerSecondMax": "2995.5213",
            "successOriginBitsPerSecondMin": "1890.546008",
            "successOriginBytesSlope": "2318",
            "successOriginBytesTotal": "1236"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,urlbytes-by-time
version,1
source,urlbytes-by-time/versions/1
groupBy,date_id
start,2019-10-04T00:00:00Z
end,2019-10-08T00:00:00Z
interval,`DAY`
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
date_id,allBytesOffload,allBytesOffloadAvg,allBytesOffloadMax,allBytesOffloadMin,allBytesOffloadSlope,allEdgeBitsPerSecond,allEdgeBitsPerSecondMax,allEdgeBitsPerSecondMin,allEdgeBytesSlope,allEdgeBytesTotal,allOriginBitsPerSecond,allOriginBitsPerSecondMax,allOriginBitsPerSecondMin,allOriginBytesSlope,allOriginBytesTotal,errorBytesOffload,errorBytesOffloadAvg,errorBytesOffloadMax,errorBytesOffloadMin,errorBytesOffloadSlope,errorEdgeBitsPerSecond,errorEdgeBitsPerSecondMax,errorEdgeBitsPerSecondMin,errorEdgeBytesSlope,errorEdgeBytesTotal,errorOriginBitsPerSecond,errorOriginBitsPerSecondMax,errorOriginBitsPerSecondMin,errorOriginBytesSlope,errorOriginBytesTotal,successBytesOffload,successBytesOffloadAvg,successBytesOffloadMax,successBytesOffloadMin,successBytesOffloadSlope,successEdgeBitsPerSecond,successEdgeBitsPerSecondMax,successEdgeBitsPerSecondMin,successEdgeBytesSlope,successEdgeBytesTotal,successOriginBitsPerSecond,successOriginBitsPerSecondMax,successOriginBitsPerSecondMin,successOriginBytesSlope,successOriginBytesTotal
#COLUMNS_END

#DATA_START
2019-10-04T00:00:00Z,93,47,82,75,1820,1248.036144,834.894292,513.959762,2057,1290,884.969329,1636.881142,852.014964,310,4864,84,74,29,15,415,3215.114656,926.499859,2419.656089,3446,2309,1425.787011,2470.837585,3622.172997,2304,2943,78,6,5,15,1688,4571.489257,1945.193079,4826.527438,2069,1226,810.991346,300.47834,3863.596406,4524,1892
2019-10-05T00:00:00Z,32,91,84,62,2948,3904.097101,4010.036458,2642.378701,2543,2666,468.419659,1076.859158,2165.272542,2080,2742,55,20,35,53,3413,4952.45134,4058.295713,3097.306194,1246,2062,1763.647414,4081.840353,1228.734693,1633,219,24,49,18,89,1141,1459.023624,3978.705048,606.357068,2265,2202,2332.424088,3264.705385,534.248991,748,4405
2019-10-06T00:00:00Z,18,49,73,77,4419,2888.544221,1451.866276,4693.991248,4357,1610,1513.532169,854.149614,2372.169375,2887,759,92,51,77,83,998,4920.682537,565.856423,1310.453488,1470,2588,468.077072,1865.455538,4362.958896,2381,821,91,28,31,66,4375,1236.567711,4328.273188,686.815402,2025,11,3127.207038,4749.236336,487.160231,1109,4162
2019-10-07T00:00:00Z,32,32,86,61,2227,3301.841841,1255.822636,1561.985002,4685,1736,2446.403628,1248.427283,132.940419,2966,3832,44,87,70,74,152,26.573552,1875.682008,2985.211032,3301,360,4642.742236,1019.891553,800.171176,2842,4666,83,23,57,41,803,604.961692,2846.712771,1522.409729,2441,2301,3304.687434,2995.5213,1890.546008,2318,1236
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/urlbytes-by-time/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "urlbytes-by-time",
    "description": "Returns URL volume data over time",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges ",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "allBytesOffload",
            "description": "The total volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Offloaded Bytes",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "allBytesOffloadAvg",
            "description": "The average volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Average Bytes Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allBytesOffloadMax",
            "description": "The highest volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Bytes Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allBytesOffloadMin",
            "description": "The lowest volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Bytes Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allBytesOffloadSlope",
            "description": "Represents the overall change in the volume that was served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Bytes Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeBitsPerSecond",
            "description": "The total rate of volume delivered from Akamai to end user.",
            "label": "Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "allEdgeBitsPerSecondMax",
            "description": "The highest rate of volume delivered from Akamai to end user.",
            "label": "Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeBitsPerSecondMin",
            "description": "The lowest rate of volume delivered from Akamai to end user.",
            "label": "Edge Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeBytesSlope",
            "description": "Represents the overall change in the volume that was served by Akamai to the end user, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeBytesTotal",
            "description": "The total volume delivered from Akamai to end user.",
            "label": "Total Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "allOriginBitsPerSecond",
            "description": "The total rate of volume delivered from the origin.",
            "label": "Origin Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "allOriginBitsPerSecondMax",
            "description": "The highest rate of volume delivered from the origin.",
            "label": "Origin Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allOriginBitsPerSecondMin",
            "description": "The lowest rate of volume delivered from the origin.",
            "label": "Origin Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allOriginBytesSlope",
            "description": "Represents the overall change in the volume delivered by the origin, a positive number if increasing or a negative number if decreasing.",
            "label": " Origin Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allOriginBytesTotal",
            "description": "The total rate of volume delivered from the origin.",
            "label": "Total Origin Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "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": "Offloaded Bytes",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "errorBytesOffloadAvg",
            "description": "The average 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": "Average Bytes Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorBytesOffloadMax",
            "description": "The highest 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": "Bytes Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorBytesOffloadMin",
            "description": "The lowest 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": "Bytes Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorBytesOffloadSlope",
            "description": "Represents the overall change in the volume of requests that returned error responses served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Bytes Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeBitsPerSecond",
            "description": "The rate of requests that returned error responses that was served by Akamai.",
            "label": "Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "errorEdgeBitsPerSecondMax",
            "description": "The highest rate of requests that returned error responses that was served by Akamai.",
            "label": "Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeBitsPerSecondMin",
            "description": "The lowest rate of requests that returned error responses that was served by Akamai.",
            "label": "Edge Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeBytesSlope",
            "description": "Represents the overall change in the volume of requests that returned error responses served by Akamai, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeBytesTotal",
            "description": "The total volume of requests that returned error responses that was served by Akamai.",
            "label": "Total Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginBitsPerSecond",
            "description": "The rate of requests that returned error responses that was served by the origin.",
            "label": "Origin Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "errorOriginBitsPerSecondMax",
            "description": "The highest rate of requests that returned error responses that was served by the origin.",
            "label": "Origin Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginBitsPerSecondMin",
            "description": "The lowest rate of requests that returned error responses that was served by the origin.",
            "label": "Origin Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginBytesSlope",
            "description": "Represents the overall change in the volume of requests that returned error responses served by the origin, a positive number if increasing or a negative number if decreasing.",
            "label": "Origin Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginBytesTotal",
            "description": "The total volume of requests that returned error responses that was served by the origin.",
            "label": "Total Origin Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "successBytesOffload",
            "description": "The volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Offloaded Bytes",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "successBytesOffloadAvg",
            "description": "The average volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Average Bytes Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successBytesOffloadMax",
            "description": "The highest volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Bytes Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successBytesOffloadMin",
            "description": "The lowest volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters.",
            "label": "Bytes Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successBytesOffloadSlope",
            "description": "Represents the overall change in the volume for successful requests that was served by Akamai as a percentage of total volume served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Bytes Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeBitsPerSecond",
            "description": "The rate of successful requests delivered from Akamai to the end user.",
            "label": "Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "successEdgeBitsPerSecondMax",
            "description": "The highest rate of successful requests delivered from Akamai to the end user.",
            "label": "Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeBitsPerSecondMin",
            "description": "The lowest rate of successful requests delivered from Akamai to the end user.",
            "label": "Edge Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeBytesSlope",
            "description": "Represents the overall change in the volume for successful requests that was served by Akamai to the end user, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeBytesTotal",
            "description": "The total rate of successful requests delivered from Akamai to the end user.",
            "label": "Total Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "successOriginBitsPerSecond",
            "description": "The rate of successful requests delivered from the origin.",
            "label": "Origin Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "successOriginBitsPerSecondMax",
            "description": "The highest rate of successful requests delivered from the origin.",
            "label": "Origin Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successOriginBitsPerSecondMin",
            "description": "The lowest rate of successful requests delivered from the origin.",
            "label": "Origin Bits/Sec Minimum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successOriginBytesSlope",
            "description": "Represents the overall change in the volume for successful requests that was served by the origin, a positive number if increasing or a negative number if decreasing.",
            "label": "Origin Bytes Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successOriginBytesTotal",
            "description": "The total volume of successful requests delivered from the origin.",
            "label": "Total Origin Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "date_id"
    ],
    "filters": [
        {
            "name": "url_not_start_with",
            "type": "string",
            "description": "URL does not start with 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
        },
        {
            "name": "url_match",
            "type": "string",
            "description": "URL matches the specified string. ",
            "required": false
        },
        {
            "name": "url_end_with",
            "type": "string",
            "description": "URL ends with the specified string. ",
            "required": false
        },
        {
            "name": "url_not_match",
            "type": "string",
            "description": "URL does not match the specified string. ",
            "required": false
        },
        {
            "name": "url_not_contain",
            "type": "string",
            "description": "URL does not contain the specified string.",
            "required": false
        },
        {
            "name": "url_contain",
            "type": "string",
            "description": "URL contains the specified string. ",
            "required": false
        },
        {
            "name": "url_start_with",
            "type": "string",
            "description": "URL starts with 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_exact_match",
            "type": "string",
            "description": "URL is an exact match for the specified string.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/urlbytes-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/urlbytes-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/urlbytes-by-time/versions/1/report-data"
        }
    ]
}