todaytraffic-by-timeandresponseclass

The following shows how to generate the todaytraffic-by-timeandresponseclass 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 today traffic data by response class.

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

Business object: cpcode

Data available for: 92 days

Required products: Kona Site Defender, Download Delivery, OTA Updates, Web Application Protector, Wholesale Delivery, Adaptive Media Delivery, Dynamic Site Accelerator, Ion, Dynamic Site Delivery, Object Delivery, or Kona DDoS Defender

Available metrics

MetricDescription
Data metrics
edgeHitsPerSecondThe number of edge requests per second for given objects and filters.
originHitsPerSecondThe number of origin requests per second for given objects and filters.

Available filters

FilterTypeDescription
Optional filters
response_classEnumerationA class of HTTP response status codes, from 0xx through 6xx.
0xx: An aborted action on the client side.
1xx: An informational response, like Continue.
2xx: A successful response.
3xx: Success, but a redirect where the thing you want is somewhere else.
4xx: Error, where there's some problem with the client request.
5xx: Error, where there's some problem with how the API server responded to the client request.
6xx: Invalid headers (defined by Akamai).
response_statusEnumerationAn indicator of whether the HTTP response resulted in success or an error.
success: Successful HTTP response status.
error: Error HTTP response status.

POST request

POST /reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp.
endString2020-06-26T14:00:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of cpcode values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of arraysSpecifies 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": [
        "edgeHitsPerSecond",
        "originHitsPerSecond"
    ],
    "filters": {
        "response_class": [
            "1xx",
            "2xx"
        ],
        "response_status": [
            "success",
            "error"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=edgeHitsPerSecond%2CoriginHitsPerSecond​&filters​=response_class%3D2xx%2Cresponse_class%3D3xx%2Cresponse_status%3Dsuccess%2Cresponse_status%3Derror

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp.
endString2020-06-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs 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.
objectIdsString55232,​23433,​32433As 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.
metricsStringedgeHitsPerSecond,​originHitsPerSecondSpecifies 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.
filtersStringresponse_class=​2xx,​response_class=​3xx,​response_status=​success,​response_status=​errorSpecifies 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.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "todaytraffic-by-timeandresponseclass",
        "version": "1",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "response_class"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "response_class",
                "values": [
                    "5xx",
                    "1xx"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "groupBy",
                "label": "response_class"
            },
            {
                "name": "edgeHitsPerSecond",
                "label": "Edge Hits/Sec"
            },
            {
                "name": "originHitsPerSecond",
                "label": "Origin Hits/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "data": [
                {
                    "response_class": "4xx",
                    "edgeHitsPerSecond": "3525.643081",
                    "originHitsPerSecond": "3910.987603"
                },
                {
                    "response_class": "0xx",
                    "edgeHitsPerSecond": "332.547339",
                    "originHitsPerSecond": "2587.721661"
                },
                {
                    "response_class": "3xx",
                    "edgeHitsPerSecond": "606.192502",
                    "originHitsPerSecond": "2450.307158"
                },
                {
                    "response_class": "5xx",
                    "edgeHitsPerSecond": "3953.411898",
                    "originHitsPerSecond": "3847.687951"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "data": [
                {
                    "response_class": "4xx",
                    "edgeHitsPerSecond": "1536.884921",
                    "originHitsPerSecond": "4513.129896"
                },
                {
                    "response_class": "0xx",
                    "edgeHitsPerSecond": "2949.142198",
                    "originHitsPerSecond": "2820.346849"
                },
                {
                    "response_class": "3xx",
                    "edgeHitsPerSecond": "4367.906814",
                    "originHitsPerSecond": "439.08616"
                },
                {
                    "response_class": "5xx",
                    "edgeHitsPerSecond": "967.757005",
                    "originHitsPerSecond": "1033.688597"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "data": [
                {
                    "response_class": "4xx",
                    "edgeHitsPerSecond": "4722.942146",
                    "originHitsPerSecond": "3484.959785"
                },
                {
                    "response_class": "0xx",
                    "edgeHitsPerSecond": "1305.660648",
                    "originHitsPerSecond": "3654.263085"
                },
                {
                    "response_class": "3xx",
                    "edgeHitsPerSecond": "983.420378",
                    "originHitsPerSecond": "4397.196843"
                },
                {
                    "response_class": "5xx",
                    "edgeHitsPerSecond": "421.229366",
                    "originHitsPerSecond": "733.602654"
                }
            ]
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "data": [
                {
                    "response_class": "4xx",
                    "edgeHitsPerSecond": "2122.151953",
                    "originHitsPerSecond": "4232.628133"
                },
                {
                    "response_class": "0xx",
                    "edgeHitsPerSecond": "976.474839",
                    "originHitsPerSecond": "3561.585253"
                },
                {
                    "response_class": "3xx",
                    "edgeHitsPerSecond": "2029.527039",
                    "originHitsPerSecond": "1601.572916"
                },
                {
                    "response_class": "5xx",
                    "edgeHitsPerSecond": "3120.201542",
                    "originHitsPerSecond": "3585.770195"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​todaytraffic-by-timeandresponseclass
version,​1
source,​todaytraffic-by-timeandresponseclass/versions/1
groupBy,​startdatetime,​response_class
start,​2020-06-26T13:40:00Z
end,​2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
response_class,​5xx,​1xx
response_status,​success,​error
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​response_class,​edgeHitsPerSecond,​originHitsPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,4xx,​3525.643081,​3910.987603
2020-06-26T13:40:00Z,0xx,​332.547339,​2587.721661
2020-06-26T13:40:00Z,3xx,​606.192502,​2450.307158
2020-06-26T13:40:00Z,5xx,​3953.411898,​3847.687951
2020-06-26T13:45:00Z,4xx,​1536.884921,​4513.129896
2020-06-26T13:45:00Z,0xx,​2949.142198,​2820.346849
2020-06-26T13:45:00Z,3xx,​4367.906814,​439.08616
2020-06-26T13:45:00Z,5xx,​967.757005,​1033.688597
2020-06-26T13:50:00Z,4xx,​4722.942146,​3484.959785
2020-06-26T13:50:00Z,0xx,​1305.660648,​3654.263085
2020-06-26T13:50:00Z,3xx,​983.420378,​4397.196843
2020-06-26T13:50:00Z,5xx,​421.229366,​733.602654
2020-06-26T13:55:00Z,4xx,​2122.151953,​4232.628133
2020-06-26T13:55:00Z,0xx,​976.474839,​3561.585253
2020-06-26T13:55:00Z,3xx,​2029.527039,​1601.572916
2020-06-26T13:55:00Z,5xx,​3120.201542,​3585.770195
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1

Status 200 application/json

Response body:

{
    "name": "todaytraffic-by-timeandresponseclass",
    "description": "Returns today traffic data by response class.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "HIERARCHICAL",
    "requiredProducts": [
        "Kona Site Defender",
        "Download Delivery",
        "OTA Updates",
        "Web Application Protector",
        "Wholesale Delivery",
        "Adaptive Media Delivery",
        "Dynamic Site Accelerator",
        "Ion",
        "Dynamic Site Delivery",
        "Object Delivery",
        "Kona DDoS Defender"
    ],
    "requiredRoles": [
        "Reports - All privileges",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeHitsPerSecond",
            "description": "The number of edge requests per second for given objects and filters.",
            "label": "Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originHitsPerSecond",
            "description": "The number of origin requests per second for given objects and filters.",
            "label": "Origin Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime",
        "response_class"
    ],
    "filters": [
        {
            "name": "response_status",
            "type": "enum",
            "description": "An indicator of whether the HTTP response resulted in success or an error.",
            "values": [
                {
                    "value": "success",
                    "description": "Successful HTTP response status."
                },
                {
                    "value": "error",
                    "description": "Error HTTP response status."
                }
            ],
            "required": false
        },
        {
            "name": "response_class",
            "type": "enum",
            "description": "A class of HTTP response status codes, from 0xx through 6xx.",
            "values": [
                {
                    "value": "0xx",
                    "description": "An aborted action on the client side."
                },
                {
                    "value": "1xx",
                    "description": "An informational response, like Continue."
                },
                {
                    "value": "2xx",
                    "description": "A successful response."
                },
                {
                    "value": "3xx",
                    "description": "Success, but a redirect where the thing you want is somewhere else."
                },
                {
                    "value": "4xx",
                    "description": "Error, where there's some problem with the client request."
                },
                {
                    "value": "5xx",
                    "description": "Error, where there's some problem with how the API server responded to the client request. "
                },
                {
                    "value": "6xx",
                    "description": "Invalid headers (defined by Akamai)."
                }
            ],
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/todaytraffic-by-timeandresponseclass/versions/1/report-data"
        }
    ]
}