The following shows how to generate the traffic-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 traffic data by response class over time.
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
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
edgeHitsPerSecond | The rate of edge requests for given objects and filters. |
originHitsPerSecond | The number of origin requests per second for given objects and filters. |
Available filters
| Filter | Type | Description |
|---|---|---|
| Optional filters | ||
delivery_type | Enumeration | Distinguishes secure from non-secure traffic. |
secure: Secure traffic. | ||
non_secure: Non-secure traffic. | ||
http_version | Enumeration | HTTP version. |
https1.1: https1.1 | ||
http2: http2 | ||
http3: http3 | ||
http1.1: http1.1 | ||
ip_version | Enumeration | Supported array values are ipv4 and ipv6. |
ipv4: IP address in v4 format. | ||
ipv6: IP address in v6 format. | ||
response_class | Enumeration | A 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_status | Enumeration | An indicator of whether the HTTP response resulted in success or an error. |
success: Successful HTTP response status. | ||
error: Error HTTP response status. | ||
traffic | Enumeration | HTTP traffic to be included in the report data. |
get_head_responses: Response header traffic from GET operations. | ||
put_post_requests: Request traffic from PUT and POST operations. | ||
all_responses: All response traffic. | ||
put_post_responses: Response traffic from PUT and POST operations. |
POST request
POST /reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1/report-data?start=2019-10-08T13%3A40%3A00Z&end=2019-10-08T14%3A00%3A00Z&interval=FIVE_MINUTES
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2022-06-23T13:55:00Z | Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value’s timestamp. |
end | String | 2022-06-23T14:15: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. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES. |
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": [
"edgeHitsPerSecond",
"originHitsPerSecond"
],
"filters": {
"ca": [
"cacheable",
"non_cacheable"
],
"delivery_type": [
"secure",
"non-secure"
],
"http_version": [
"https1.1",
"http2"
],
"ip_version": [
"ipv4",
"ipv6"
],
"response_class": [
"1xx",
"5xx"
],
"response_status": [
"success",
"error"
],
"traffic": [
"put_post_responses",
"put_post_requests"
]
}
}
GET request
GET /reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1/report-data?start=2019-10-08T13%3A40%3A00Z&end=2019-10-08T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=edgeHitsPerSecond%2CoriginHitsPerSecond&filters=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure%2Cip_version%3Dipv4%2Cip_version%3Dipv6
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2022-06-23T13:55:00Z | Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value’s timestamp. |
end | String | 2022-06-23T14:15: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. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES. |
| 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 | edgeHitsPerSecond,originHitsPerSecond | 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,ip_version=ipv4,ip_version=ipv6 | 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. |
JSON response
Status 200 application/json
Response body:
{
"metadata": {
"name": "traffic-by-timeandresponseclass",
"version": "1",
"outputType": "HIERARCHICAL",
"groupBy": [
"startdatetime",
"response_class"
],
"interval": "FIVE_MINUTES",
"start": "2022-06-09T13:55:00Z",
"end": "2022-06-09T14:15:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "ca",
"values": [
"cacheable",
"non_cacheable"
]
},
{
"name": "delivery_type",
"values": [
"secure",
"non-secure"
]
},
{
"name": "http_version",
"values": [
"https1.1",
"http2"
]
},
{
"name": "ip_version",
"values": [
"ipv4",
"ipv6"
]
},
{
"name": "response_class",
"values": [
"4xx",
"0xx"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
},
{
"name": "traffic",
"values": [
"get_head_responses",
"put_post_requests"
]
}
],
"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": "2022-06-09T13:55:00Z",
"data": [
{
"response_class": "0xx",
"edgeHitsPerSecond": "2516.029713",
"originHitsPerSecond": "18.682861"
},
{
"response_class": "2xx",
"edgeHitsPerSecond": "1196.768309",
"originHitsPerSecond": "2300.686867"
},
{
"response_class": "1xx",
"edgeHitsPerSecond": "4319.572674",
"originHitsPerSecond": "4086.313779"
},
{
"response_class": "4xx",
"edgeHitsPerSecond": "2467.545043",
"originHitsPerSecond": "1116.943727"
}
]
},
{
"startdatetime": "2022-06-09T14:00:00Z",
"data": [
{
"response_class": "0xx",
"edgeHitsPerSecond": "3365.431587",
"originHitsPerSecond": "2174.421944"
},
{
"response_class": "2xx",
"edgeHitsPerSecond": "3542.544917",
"originHitsPerSecond": "3413.472432"
},
{
"response_class": "1xx",
"edgeHitsPerSecond": "2056.805753",
"originHitsPerSecond": "2189.367231"
},
{
"response_class": "4xx",
"edgeHitsPerSecond": "3429.299862",
"originHitsPerSecond": "387.441993"
}
]
},
{
"startdatetime": "2022-06-09T14:05:00Z",
"data": [
{
"response_class": "0xx",
"edgeHitsPerSecond": "1982.945218",
"originHitsPerSecond": "3570.894993"
},
{
"response_class": "2xx",
"edgeHitsPerSecond": "1004.390878",
"originHitsPerSecond": "1770.308713"
},
{
"response_class": "1xx",
"edgeHitsPerSecond": "4242.583252",
"originHitsPerSecond": "3802.33716"
},
{
"response_class": "4xx",
"edgeHitsPerSecond": "3883.44179",
"originHitsPerSecond": "2750.412274"
}
]
},
{
"startdatetime": "2022-06-09T14:10:00Z",
"data": [
{
"response_class": "0xx",
"edgeHitsPerSecond": "348.05797",
"originHitsPerSecond": "2696.047334"
},
{
"response_class": "2xx",
"edgeHitsPerSecond": "846.909709",
"originHitsPerSecond": "1879.432501"
},
{
"response_class": "1xx",
"edgeHitsPerSecond": "1095.2133",
"originHitsPerSecond": "2760.795596"
},
{
"response_class": "4xx",
"edgeHitsPerSecond": "2089.245007",
"originHitsPerSecond": "3689.447235"
}
]
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,traffic-by-timeandresponseclass
version,1
source,traffic-by-timeandresponseclass/versions/1
groupBy,startdatetime,response_class
start,2022-06-09T13:55:00Z
end,2022-06-09T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
ca,cacheable,non_cacheable
delivery_type,secure,non-secure
http_version,https1.1,http2
ip_version,ipv4,ipv6
response_class,4xx,0xx
response_status,success,error
traffic,get_head_responses,put_post_requests
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,response_class,edgeHitsPerSecond,originHitsPerSecond
#COLUMNS_END
#DATA_START
2022-06-09T13:55:00Z,0xx,2516.029713,18.682861
2022-06-09T13:55:00Z,2xx,1196.768309,2300.686867
2022-06-09T13:55:00Z,1xx,4319.572674,4086.313779
2022-06-09T13:55:00Z,4xx,2467.545043,1116.943727
2022-06-09T14:00:00Z,0xx,3365.431587,2174.421944
2022-06-09T14:00:00Z,2xx,3542.544917,3413.472432
2022-06-09T14:00:00Z,1xx,2056.805753,2189.367231
2022-06-09T14:00:00Z,4xx,3429.299862,387.441993
2022-06-09T14:05:00Z,0xx,1982.945218,3570.894993
2022-06-09T14:05:00Z,2xx,1004.390878,1770.308713
2022-06-09T14:05:00Z,1xx,4242.583252,3802.33716
2022-06-09T14:05:00Z,4xx,3883.44179,2750.412274
2022-06-09T14:10:00Z,0xx,348.05797,2696.047334
2022-06-09T14:10:00Z,2xx,846.909709,1879.432501
2022-06-09T14:10:00Z,1xx,1095.2133,2760.795596
2022-06-09T14:10:00Z,4xx,2089.245007,3689.447235
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the traffic-by-timeandresponseclass report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1
Status 200 application/json
Response body:
{
"name": "traffic-by-timeandresponseclass",
"description": "Returns traffic data by response class over time.",
"businessObjectName": "cpcode",
"version": 1,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"supportsPagination": false,
"outputType": "HIERARCHICAL",
"requiredProducts": [
"Basic Traffic Reports"
],
"requiredRoles": [
"Reports - All privileges",
"Reports - View only",
"OTA App User"
],
"available": true,
"metrics": [
{
"name": "edgeHitsPerSecond",
"description": "The rate of edge requests 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": "ip_version",
"type": "enum",
"description": "Supported array values are ipv4 and ipv6.",
"values": [
{
"value": "ipv4",
"description": "IP address in v4 format."
},
{
"value": "ipv6",
"description": "IP address in v6 format."
}
],
"required": false
},
{
"name": "traffic",
"type": "enum",
"description": "HTTP traffic to be included in the report data. ",
"values": [
{
"value": "put_post_requests",
"description": "Request traffic from PUT and POST operations."
},
{
"value": "get_head_responses",
"description": "Response header traffic from GET operations."
},
{
"value": "all_responses",
"description": "All response traffic."
},
{
"value": "put_post_responses",
"description": "Response traffic from PUT and POST operations."
}
],
"required": false
},
{
"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": "http_version",
"type": "enum",
"description": "HTTP version. ",
"values": [
{
"value": "https1.1",
"description": "https1.1"
},
{
"value": "http2",
"description": "http2"
},
{
"value": "http3",
"description": "http3"
},
{
"value": "http1.1",
"description": "http1.1"
}
],
"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
},
{
"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": "ca",
"type": "enum",
"description": "Indicates whether content is storable. ",
"values": [
{
"value": "non_cacheable",
"description": "Can't be stored (identified as 'no-store' or has a 0 TTL) and will always trigger an origin request."
},
{
"value": "cacheable",
"description": "Can be stored after an initial request for faster future delivery."
}
],
"required": false
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 92,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/traffic-by-timeandresponseclass/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/traffic-by-timeandresponseclass/versions/1/report-data"
}
]
}