urlhits-by-time report

The following shows how to generate the urlhits-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 traffic 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
allEdgeHitsPerSecond The rate of hits from Akamai to the end user.
allEdgeHitsPerSecondMax The highest rate of hits from Akamai to the end user.
allEdgeHitsPerSecondMin The lowest rate of hits from Akamai to the end user.
allEdgeHitsSlope Represents the overall change in the number of hits from Akamai to the end user, a positive number if increasing or a negative number if decreasing.
allEdgeHitsTotal The total number of hits from Akamai to the end user.
allHitsOffload The total number of hits that Akamai served as a percentage of total hits served for given objects and filters.
allHitsOffloadAvg The average number of hits that Akamai served as a percentage of total hits served for given objects and filters.
allHitsOffloadMax The highest number of hits that Akamai served as a percentage of total hits served for given objects and filters.
allHitsOffloadMin The lowest number of hits that Akamai served as a percentage of total hits served for given objects and filters.
allHitsOffloadSlope Represents the overall change in the number of hits that Akamai served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.
allOriginHitsPerSecond The rate of hits at the origin.
allOriginHitsPerSecondMax The highest rate of hits at the origin.
allOriginHitsPerSecondMin The lowest rate of hits at the origin.
allOriginHitsSlope Represents the overall change in the number of hits that the origin served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing
allOriginHitsTotal The total rate of hits at the origin.
errorEdgeHitsPerSecond The rate of hits from Akamai to the end user returning error responses.
errorEdgeHitsPerSecondMax The highest rate of hits from Akamai to the end user returning error responses.
errorEdgeHitsPerSecondMin The lowest rate of hits from Akamai to the end user returning error responses.
errorEdgeHitsSlope Represents the overall change in the number of URLs returning error responses, a positive number if increasing or a negative number if decreasing.
errorEdgeHitsTotal The total number of hits from Akamai to the end user returning error responses.
errorHitsOffload The number of URLs returning errors as a percentage of total hits served for given objects and filters.
errorHitsOffloadAvg The average number of URLs returning errors as a percentage of total hits served for given objects and filters.
errorHitsOffloadMax The highest number of URLs returning errors as a percentage of total hits served for given objects and filters.
errorHitsOffloadMin The lowest number of URLs returning errors as a percentage of total hits served for given objects and filters.
errorHitsOffloadSlope Represents the overall change in the number of URLs returning errors as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.
errorOriginHitsPerSecond The rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.
errorOriginHitsPerSecondMax The highest rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.
errorOriginHitsPerSecondMin The lowest rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.
errorOriginHitsSlope Represents the overall change in the number of URLs returning errors from the origin as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.
errorOriginHitsTotal The total number of URL hits returning errors from the origin as a percentage of total hits served for given objects and filters.
successEdgeHitsPerSecond The rate of hits from Akamai to the end user returning success responses.
successEdgeHitsPerSecondMax The highest rate of hits from Akamai to the end user returning success responses.
successEdgeHitsPerSecondMin The lowest rate of hits from Akamai to the end user returning success responses.
successEdgeHitsSlope Represents the overall change in the number of URLs returning success responses, a positive number if increasing or a negative number if decreasing.
successEdgeHitsTotal The total number of hits from Akamai to the end user returning success responses.
successHitsOffload The number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.
successHitsOffloadAvg The average number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.
successHitsOffloadMax The highest number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.
successHitsOffloadMin The lowest number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.
successHitsOffloadSlope Represents the overall change in the number of successful hits that Akamai served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.
successOriginHitsPerSecond The rate of successful hits that the origin served.
successOriginHitsPerSecondMax The highest rate of successful hits that the origin served.
successOriginHitsPerSecondMin The lowest rate of successful hits that the origin served.
successOriginHitsSlope Represents the overall change in the number of successful hits that the origin served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.
successOriginHitsTotal The total rate of successful hits that the origin served.

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/urlhits-by-time/versions/1/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/urlhits-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": [
        "allEdgeHitsPerSecond",
        "allEdgeHitsPerSecondMax",
        "allEdgeHitsPerSecondMin",
        "allEdgeHitsSlope",
        "allEdgeHitsTotal",
        "allHitsOffload",
        "allHitsOffloadAvg",
        "allHitsOffloadMax",
        "allHitsOffloadMin",
        "allHitsOffloadSlope",
        "allOriginHitsPerSecond",
        "allOriginHitsPerSecondMax",
        "allOriginHitsPerSecondMin",
        "allOriginHitsSlope",
        "allOriginHitsTotal",
        "errorEdgeHitsPerSecond",
        "errorEdgeHitsPerSecondMax",
        "errorEdgeHitsPerSecondMin",
        "errorEdgeHitsSlope",
        "errorEdgeHitsTotal",
        "errorHitsOffload",
        "errorHitsOffloadAvg",
        "errorHitsOffloadMax",
        "errorHitsOffloadMin",
        "errorHitsOffloadSlope",
        "errorOriginHitsPerSecond",
        "errorOriginHitsPerSecondMax",
        "errorOriginHitsPerSecondMin",
        "errorOriginHitsSlope",
        "errorOriginHitsTotal",
        "successEdgeHitsPerSecond",
        "successEdgeHitsPerSecondMax",
        "successEdgeHitsPerSecondMin",
        "successEdgeHitsSlope",
        "successEdgeHitsTotal",
        "successHitsOffload",
        "successHitsOffloadAvg",
        "successHitsOffloadMax",
        "successHitsOffloadMin",
        "successHitsOffloadSlope",
        "successOriginHitsPerSecond",
        "successOriginHitsPerSecondMax",
        "successOriginHitsPerSecondMin",
        "successOriginHitsSlope",
        "successOriginHitsTotal"
    ],
    "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": [
            ".pdf",
            ".doc"
        ],
        "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/urlhits-by-time/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}

Sample: /reporting-api/v1/reports/urlhits-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=allEdgeHitsPerSecond%2CallEdgeHitsPerSecondMax&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 allEdgeHitsPerSecond,allEdgeHitsPerSecondMax 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": "urlhits-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",
                    ".doc"
                ]
            },
            {
                "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": "allEdgeHitsPerSecond",
                "label": "Edge Hits/Sec"
            },
            {
                "name": "allEdgeHitsPerSecondMax",
                "label": "Edge Hits/Sec Maximum"
            },
            {
                "name": "allEdgeHitsPerSecondMin",
                "label": "Edge Hits/Sec Minimum"
            },
            {
                "name": "allEdgeHitsSlope",
                "label": "Edge Hits Slope"
            },
            {
                "name": "allEdgeHitsTotal",
                "label": "Total Edge Hits"
            },
            {
                "name": "allHitsOffload",
                "label": "Offloaded Hits"
            },
            {
                "name": "allHitsOffloadAvg",
                "label": "Average Hits Offload"
            },
            {
                "name": "allHitsOffloadMax",
                "label": "Hits Offload Maximum"
            },
            {
                "name": "allHitsOffloadMin",
                "label": "Hits Offload Minimum"
            },
            {
                "name": "allHitsOffloadSlope",
                "label": "Hits Offload  Slope"
            },
            {
                "name": "allOriginHitsPerSecond",
                "label": "Origin Hits/Sec"
            },
            {
                "name": "allOriginHitsPerSecondMax",
                "label": "Origin Hits/Sec Maximum"
            },
            {
                "name": "allOriginHitsPerSecondMin",
                "label": "Origin Hits/Sec Minimum"
            },
            {
                "name": "allOriginHitsSlope",
                "label": "Origin Hits Slope"
            },
            {
                "name": "allOriginHitsTotal",
                "label": "Total Origin Hits"
            },
            {
                "name": "errorEdgeHitsPerSecond",
                "label": "Edge Hits/Sec"
            },
            {
                "name": "errorEdgeHitsPerSecondMax",
                "label": "Edge Hits/Sec Maximum"
            },
            {
                "name": "errorEdgeHitsPerSecondMin",
                "label": "Edge Hits/Sec Minimum"
            },
            {
                "name": "errorEdgeHitsSlope",
                "label": "Edge Hits Slope"
            },
            {
                "name": "errorEdgeHitsTotal",
                "label": "Total Edge Hits"
            },
            {
                "name": "errorHitsOffload",
                "label": "Offloaded Hits"
            },
            {
                "name": "errorHitsOffloadAvg",
                "label": "Average Hits Offload"
            },
            {
                "name": "errorHitsOffloadMax",
                "label": "Hits Offload Maximum"
            },
            {
                "name": "errorHitsOffloadMin",
                "label": "Hits Offload Minimum"
            },
            {
                "name": "errorHitsOffloadSlope",
                "label": "Hits Offload  Slope"
            },
            {
                "name": "errorOriginHitsPerSecond",
                "label": "Origin Hits/Sec"
            },
            {
                "name": "errorOriginHitsPerSecondMax",
                "label": "Origin Hits/Sec Maximum"
            },
            {
                "name": "errorOriginHitsPerSecondMin",
                "label": "Origin Hits/Sec Minimum"
            },
            {
                "name": "errorOriginHitsSlope",
                "label": "Origin Hits Slope"
            },
            {
                "name": "errorOriginHitsTotal",
                "label": "Total Origin Hits"
            },
            {
                "name": "successEdgeHitsPerSecond",
                "label": "Edge Hits/Sec"
            },
            {
                "name": "successEdgeHitsPerSecondMax",
                "label": "Edge Hits/Sec Maximum"
            },
            {
                "name": "successEdgeHitsPerSecondMin",
                "label": "Edge Hits/Sec Minimum"
            },
            {
                "name": "successEdgeHitsSlope",
                "label": "Edge Hits Slope"
            },
            {
                "name": "successEdgeHitsTotal",
                "label": "Total Edge Hits"
            },
            {
                "name": "successHitsOffload",
                "label": "Offloaded Hits"
            },
            {
                "name": "successHitsOffloadAvg",
                "label": "Average Hits Offload"
            },
            {
                "name": "successHitsOffloadMax",
                "label": "Hits Offload Maximum"
            },
            {
                "name": "successHitsOffloadMin",
                "label": "Hits Offload Minimum"
            },
            {
                "name": "successHitsOffloadSlope",
                "label": "Hits Offload  Slope"
            },
            {
                "name": "successOriginHitsPerSecond",
                "label": "Origin Hits/Sec"
            },
            {
                "name": "successOriginHitsPerSecondMax",
                "label": "Origin Hits/Sec Maximum"
            },
            {
                "name": "successOriginHitsPerSecondMin",
                "label": "Origin Hits/Sec Minimum"
            },
            {
                "name": "successOriginHitsSlope",
                "label": "Origin Hits Slope"
            },
            {
                "name": "successOriginHitsTotal",
                "label": "Total Origin Hits"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "date_id": "2019-10-04T00:00:00Z",
            "allEdgeHitsPerSecond": "3049.509984",
            "allEdgeHitsPerSecondMax": "811.339075",
            "allEdgeHitsPerSecondMin": "3503.656691",
            "allEdgeHitsSlope": "4826",
            "allEdgeHitsTotal": "2758",
            "allHitsOffload": "72",
            "allHitsOffloadAvg": "53",
            "allHitsOffloadMax": "98",
            "allHitsOffloadMin": "68",
            "allHitsOffloadSlope": "3598",
            "allOriginHitsPerSecond": "1719.942613",
            "allOriginHitsPerSecondMax": "4608.353027",
            "allOriginHitsPerSecondMin": "4154.963323",
            "allOriginHitsSlope": "101",
            "allOriginHitsTotal": "3381",
            "errorEdgeHitsPerSecond": "2011.424464",
            "errorEdgeHitsPerSecondMax": "3362.867923",
            "errorEdgeHitsPerSecondMin": "159.874792",
            "errorEdgeHitsSlope": "3859",
            "errorEdgeHitsTotal": "4381",
            "errorHitsOffload": "23",
            "errorHitsOffloadAvg": "39",
            "errorHitsOffloadMax": "46",
            "errorHitsOffloadMin": "69",
            "errorHitsOffloadSlope": "2722",
            "errorOriginHitsPerSecond": "859.591837",
            "errorOriginHitsPerSecondMax": "4352.655484",
            "errorOriginHitsPerSecondMin": "2211.956022",
            "errorOriginHitsSlope": "3576",
            "errorOriginHitsTotal": "2146",
            "successEdgeHitsPerSecond": "691.281538",
            "successEdgeHitsPerSecondMax": "3963.290638",
            "successEdgeHitsPerSecondMin": "405.524741",
            "successEdgeHitsSlope": "697",
            "successEdgeHitsTotal": "3575",
            "successHitsOffload": "73",
            "successHitsOffloadAvg": "79",
            "successHitsOffloadMax": "99",
            "successHitsOffloadMin": "89",
            "successHitsOffloadSlope": "1972",
            "successOriginHitsPerSecond": "4778.115328",
            "successOriginHitsPerSecondMax": "578.493969",
            "successOriginHitsPerSecondMin": "4295.962218",
            "successOriginHitsSlope": "4604",
            "successOriginHitsTotal": "2993"
        },
        {
            "date_id": "2019-10-05T00:00:00Z",
            "allEdgeHitsPerSecond": "665.33019",
            "allEdgeHitsPerSecondMax": "2404.20482",
            "allEdgeHitsPerSecondMin": "3759.25204",
            "allEdgeHitsSlope": "3110",
            "allEdgeHitsTotal": "2842",
            "allHitsOffload": "2",
            "allHitsOffloadAvg": "31",
            "allHitsOffloadMax": "43",
            "allHitsOffloadMin": "85",
            "allHitsOffloadSlope": "3436",
            "allOriginHitsPerSecond": "2542.36434",
            "allOriginHitsPerSecondMax": "169.566014",
            "allOriginHitsPerSecondMin": "3894.467407",
            "allOriginHitsSlope": "1560",
            "allOriginHitsTotal": "655",
            "errorEdgeHitsPerSecond": "3961.093354",
            "errorEdgeHitsPerSecondMax": "370.639116",
            "errorEdgeHitsPerSecondMin": "1963.84407",
            "errorEdgeHitsSlope": "709",
            "errorEdgeHitsTotal": "1310",
            "errorHitsOffload": "72",
            "errorHitsOffloadAvg": "44",
            "errorHitsOffloadMax": "15",
            "errorHitsOffloadMin": "85",
            "errorHitsOffloadSlope": "3976",
            "errorOriginHitsPerSecond": "2894.145932",
            "errorOriginHitsPerSecondMax": "4220.702498",
            "errorOriginHitsPerSecondMin": "2135.261158",
            "errorOriginHitsSlope": "699",
            "errorOriginHitsTotal": "4177",
            "successEdgeHitsPerSecond": "4229.16131",
            "successEdgeHitsPerSecondMax": "3033.903961",
            "successEdgeHitsPerSecondMin": "1212.67482",
            "successEdgeHitsSlope": "1152",
            "successEdgeHitsTotal": "27",
            "successHitsOffload": "51",
            "successHitsOffloadAvg": "5",
            "successHitsOffloadMax": "37",
            "successHitsOffloadMin": "63",
            "successHitsOffloadSlope": "1874",
            "successOriginHitsPerSecond": "232.384155",
            "successOriginHitsPerSecondMax": "1493.251141",
            "successOriginHitsPerSecondMin": "3943.404875",
            "successOriginHitsSlope": "2928",
            "successOriginHitsTotal": "4677"
        },
        {
            "date_id": "2019-10-06T00:00:00Z",
            "allEdgeHitsPerSecond": "3687.047185",
            "allEdgeHitsPerSecondMax": "1626.189931",
            "allEdgeHitsPerSecondMin": "2879.962603",
            "allEdgeHitsSlope": "2748",
            "allEdgeHitsTotal": "1782",
            "allHitsOffload": "4",
            "allHitsOffloadAvg": "24",
            "allHitsOffloadMax": "20",
            "allHitsOffloadMin": "60",
            "allHitsOffloadSlope": "4145",
            "allOriginHitsPerSecond": "641.994502",
            "allOriginHitsPerSecondMax": "3479.6455",
            "allOriginHitsPerSecondMin": "51.174791",
            "allOriginHitsSlope": "3196",
            "allOriginHitsTotal": "4213",
            "errorEdgeHitsPerSecond": "3997.256991",
            "errorEdgeHitsPerSecondMax": "3195.403663",
            "errorEdgeHitsPerSecondMin": "4410.901358",
            "errorEdgeHitsSlope": "4886",
            "errorEdgeHitsTotal": "3809",
            "errorHitsOffload": "45",
            "errorHitsOffloadAvg": "43",
            "errorHitsOffloadMax": "62",
            "errorHitsOffloadMin": "96",
            "errorHitsOffloadSlope": "4135",
            "errorOriginHitsPerSecond": "94.841493",
            "errorOriginHitsPerSecondMax": "4658.809878",
            "errorOriginHitsPerSecondMin": "1505.672072",
            "errorOriginHitsSlope": "1887",
            "errorOriginHitsTotal": "4415",
            "successEdgeHitsPerSecond": "3951.65448",
            "successEdgeHitsPerSecondMax": "726.515325",
            "successEdgeHitsPerSecondMin": "3430.142116",
            "successEdgeHitsSlope": "3991",
            "successEdgeHitsTotal": "4744",
            "successHitsOffload": "4",
            "successHitsOffloadAvg": "30",
            "successHitsOffloadMax": "19",
            "successHitsOffloadMin": "55",
            "successHitsOffloadSlope": "1621",
            "successOriginHitsPerSecond": "2769.558748",
            "successOriginHitsPerSecondMax": "4234.064176",
            "successOriginHitsPerSecondMin": "3297.253702",
            "successOriginHitsSlope": "575",
            "successOriginHitsTotal": "2743"
        },
        {
            "date_id": "2019-10-07T00:00:00Z",
            "allEdgeHitsPerSecond": "4765.247168",
            "allEdgeHitsPerSecondMax": "2695.984747",
            "allEdgeHitsPerSecondMin": "180.949371",
            "allEdgeHitsSlope": "3972",
            "allEdgeHitsTotal": "3397",
            "allHitsOffload": "66",
            "allHitsOffloadAvg": "70",
            "allHitsOffloadMax": "31",
            "allHitsOffloadMin": "99",
            "allHitsOffloadSlope": "1355",
            "allOriginHitsPerSecond": "2897.905597",
            "allOriginHitsPerSecondMax": "447.530952",
            "allOriginHitsPerSecondMin": "3716.478048",
            "allOriginHitsSlope": "365",
            "allOriginHitsTotal": "2414",
            "errorEdgeHitsPerSecond": "4121.836308",
            "errorEdgeHitsPerSecondMax": "78.760656",
            "errorEdgeHitsPerSecondMin": "2172.529",
            "errorEdgeHitsSlope": "2455",
            "errorEdgeHitsTotal": "4314",
            "errorHitsOffload": "94",
            "errorHitsOffloadAvg": "20",
            "errorHitsOffloadMax": "74",
            "errorHitsOffloadMin": "18",
            "errorHitsOffloadSlope": "3420",
            "errorOriginHitsPerSecond": "3858.915475",
            "errorOriginHitsPerSecondMax": "1125.151589",
            "errorOriginHitsPerSecondMin": "327.512739",
            "errorOriginHitsSlope": "4631",
            "errorOriginHitsTotal": "348",
            "successEdgeHitsPerSecond": "4426.865005",
            "successEdgeHitsPerSecondMax": "3109.453444",
            "successEdgeHitsPerSecondMin": "3702.868437",
            "successEdgeHitsSlope": "1577",
            "successEdgeHitsTotal": "2472",
            "successHitsOffload": "63",
            "successHitsOffloadAvg": "70",
            "successHitsOffloadMax": "93",
            "successHitsOffloadMin": "11",
            "successHitsOffloadSlope": "293",
            "successOriginHitsPerSecond": "2522.979375",
            "successOriginHitsPerSecondMax": "3998.948493",
            "successOriginHitsPerSecondMin": "254.267053",
            "successOriginHitsSlope": "499",
            "successOriginHitsTotal": "4022"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,urlhits-by-time
version,1
source,urlhits-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,.doc
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,allEdgeHitsPerSecond,allEdgeHitsPerSecondMax,allEdgeHitsPerSecondMin,allEdgeHitsSlope,allEdgeHitsTotal,allHitsOffload,allHitsOffloadAvg,allHitsOffloadMax,allHitsOffloadMin,allHitsOffloadSlope,allOriginHitsPerSecond,allOriginHitsPerSecondMax,allOriginHitsPerSecondMin,allOriginHitsSlope,allOriginHitsTotal,errorEdgeHitsPerSecond,errorEdgeHitsPerSecondMax,errorEdgeHitsPerSecondMin,errorEdgeHitsSlope,errorEdgeHitsTotal,errorHitsOffload,errorHitsOffloadAvg,errorHitsOffloadMax,errorHitsOffloadMin,errorHitsOffloadSlope,errorOriginHitsPerSecond,errorOriginHitsPerSecondMax,errorOriginHitsPerSecondMin,errorOriginHitsSlope,errorOriginHitsTotal,successEdgeHitsPerSecond,successEdgeHitsPerSecondMax,successEdgeHitsPerSecondMin,successEdgeHitsSlope,successEdgeHitsTotal,successHitsOffload,successHitsOffloadAvg,successHitsOffloadMax,successHitsOffloadMin,successHitsOffloadSlope,successOriginHitsPerSecond,successOriginHitsPerSecondMax,successOriginHitsPerSecondMin,successOriginHitsSlope,successOriginHitsTotal
#COLUMNS_END

#DATA_START
2019-10-04T00:00:00Z,3049.509984,811.339075,3503.656691,4826,2758,72,53,98,68,3598,1719.942613,4608.353027,4154.963323,101,3381,2011.424464,3362.867923,159.874792,3859,4381,23,39,46,69,2722,859.591837,4352.655484,2211.956022,3576,2146,691.281538,3963.290638,405.524741,697,3575,73,79,99,89,1972,4778.115328,578.493969,4295.962218,4604,2993
2019-10-05T00:00:00Z,665.33019,2404.20482,3759.25204,3110,2842,2,31,43,85,3436,2542.36434,169.566014,3894.467407,1560,655,3961.093354,370.639116,1963.84407,709,1310,72,44,15,85,3976,2894.145932,4220.702498,2135.261158,699,4177,4229.16131,3033.903961,1212.67482,1152,27,51,5,37,63,1874,232.384155,1493.251141,3943.404875,2928,4677
2019-10-06T00:00:00Z,3687.047185,1626.189931,2879.962603,2748,1782,4,24,20,60,4145,641.994502,3479.6455,51.174791,3196,4213,3997.256991,3195.403663,4410.901358,4886,3809,45,43,62,96,4135,94.841493,4658.809878,1505.672072,1887,4415,3951.65448,726.515325,3430.142116,3991,4744,4,30,19,55,1621,2769.558748,4234.064176,3297.253702,575,2743
2019-10-07T00:00:00Z,4765.247168,2695.984747,180.949371,3972,3397,66,70,31,99,1355,2897.905597,447.530952,3716.478048,365,2414,4121.836308,78.760656,2172.529,2455,4314,94,20,74,18,3420,3858.915475,1125.151589,327.512739,4631,348,4426.865005,3109.453444,3702.868437,1577,2472,63,70,93,11,293,2522.979375,3998.948493,254.267053,499,4022
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "urlhits-by-time",
    "description": "Returns URL traffic 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": "allEdgeHitsPerSecond",
            "description": "The rate of hits from Akamai to the end user.",
            "label": "Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "allEdgeHitsPerSecondMax",
            "description": "The highest rate of hits from Akamai to the end user.",
            "label": "Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeHitsPerSecondMin",
            "description": "The lowest rate of hits from Akamai to the end user.",
            "label": "Edge Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeHitsSlope",
            "description": "Represents the overall change in the number of hits from Akamai to the end user, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allEdgeHitsTotal",
            "description": "The total number of hits from Akamai to the end user.",
            "label": "Total Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allHitsOffload",
            "description": "The total number of hits that Akamai served as a percentage of total hits served for given objects and filters. ",
            "label": "Offloaded Hits",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "allHitsOffloadAvg",
            "description": "The average number of hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Average Hits Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allHitsOffloadMax",
            "description": "The highest number of hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allHitsOffloadMin",
            "description": "The lowest number of hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "allHitsOffloadSlope",
            "description": "Represents the overall change in the number of hits that Akamai served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Hits Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allOriginHitsPerSecond",
            "description": "The rate of hits at the origin.",
            "label": "Origin Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "allOriginHitsPerSecondMax",
            "description": "The highest rate of hits at the origin.",
            "label": "Origin Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allOriginHitsPerSecondMin",
            "description": "The lowest rate of hits at the origin.",
            "label": "Origin Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "allOriginHitsSlope",
            "description": "Represents the overall change in the number of hits that the origin served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing",
            "label": "Origin Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allOriginHitsTotal",
            "description": "The total rate of hits at the origin.",
            "label": "Total Origin Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeHitsPerSecond",
            "description": "The rate of hits from Akamai to the end user returning error responses.",
            "label": "Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "errorEdgeHitsPerSecondMax",
            "description": "The highest rate of hits from Akamai to the end user returning error responses.",
            "label": "Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeHitsPerSecondMin",
            "description": "The lowest rate of hits from Akamai to the end user returning error responses.",
            "label": "Edge Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeHitsSlope",
            "description": "Represents the overall change in the number of URLs returning error responses, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorEdgeHitsTotal",
            "description": "The total number of hits from Akamai to the end user returning error responses.",
            "label": "Total Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorHitsOffload",
            "description": "The number of URLs returning errors as a percentage of total hits served for given objects and filters.",
            "label": "Offloaded Hits",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "errorHitsOffloadAvg",
            "description": "The average number of URLs returning errors as a percentage of total hits served for given objects and filters.",
            "label": "Average Hits Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorHitsOffloadMax",
            "description": "The highest number of URLs returning errors as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorHitsOffloadMin",
            "description": "The lowest number of URLs returning errors as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "errorHitsOffloadSlope",
            "description": "Represents the overall change in the number of URLs returning errors as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Hits Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginHitsPerSecond",
            "description": "The rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.",
            "label": "Origin Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "errorOriginHitsPerSecondMax",
            "description": "The highest rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.",
            "label": "Origin Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginHitsPerSecondMin",
            "description": "The lowest rate of URLs returning errors from the origin as a percentage of total hits served for given objects and filters.",
            "label": "Origin Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginHitsSlope",
            "description": "Represents the overall change in the number of URLs returning errors from the origin as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Origin Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "errorOriginHitsTotal",
            "description": "The total number of URL hits returning errors from the origin as a percentage of total hits served for given objects and filters.",
            "label": "Total Origin Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeHitsPerSecond",
            "description": "The rate of hits from Akamai to the end user returning success responses.",
            "label": "Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "successEdgeHitsPerSecondMax",
            "description": "The highest rate of hits from Akamai to the end user returning success responses.",
            "label": "Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeHitsPerSecondMin",
            "description": "The lowest rate of hits from Akamai to the end user returning success responses.",
            "label": "Edge Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeHitsSlope",
            "description": "Represents the overall change in the number of URLs returning success responses, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successEdgeHitsTotal",
            "description": "The total number of hits from Akamai to the end user returning success responses.",
            "label": "Total Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successHitsOffload",
            "description": "The number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Offloaded Hits",
            "unit": "RATIO",
            "summaryStatistic": false
        },
        {
            "name": "successHitsOffloadAvg",
            "description": "The average number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Average Hits Offload",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successHitsOffloadMax",
            "description": "The highest number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Maximum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successHitsOffloadMin",
            "description": "The lowest number of successful hits that Akamai served as a percentage of total hits served for given objects and filters.",
            "label": "Hits Offload Minimum",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "successHitsOffloadSlope",
            "description": "Represents the overall change in the number of successful hits that Akamai served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Hits Offload  Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successOriginHitsPerSecond",
            "description": "The rate of successful hits that the origin served.",
            "label": "Origin Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "successOriginHitsPerSecondMax",
            "description": "The highest rate of successful hits that the origin served.",
            "label": "Origin Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successOriginHitsPerSecondMin",
            "description": "The lowest rate of successful hits that the origin served.",
            "label": "Origin Hits/Sec Minimum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "successOriginHitsSlope",
            "description": "Represents the overall change in the number of successful hits that the origin served as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing.",
            "label": "Origin Hits Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "successOriginHitsTotal",
            "description": "The total rate of successful hits that the origin served.",
            "label": "Total Origin Hits",
            "unit": "COUNT",
            "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_not_match",
            "type": "string",
            "description": "URL does not match the specified string.",
            "required": false
        },
        {
            "name": "url_end_with",
            "type": "string",
            "description": "URL ends with 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/urlhits-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/urlhits-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/urlhits-by-time/versions/1/report-data"
        }
    ]
}