traffic-by-timeandresponse report
The following shows how to generate the
traffic-by-timeandresponse
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 HTTP response 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. | |
originHitsPer |
The rate of origin requests 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. |
||
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_code |
String | An HTTP response status code, for example, 201. |
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. |
Sample report
POST /reporting-api/v1/reports/traffic-by-timeandresponse/versions/1/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/traffic-by-timeandresponse/versions/1/report-data?start=2019-10-08T13%3A40%3A00Z&end=2019-10-08T14%3A00%3A00Z&interval=FIVE_MINUTES
Object type: Query
Download schema: report-request-schema.json
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start |
String | 2019-10-08T13:40: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-08T14:00:00Z |
Specifies if unavailable reports should be shown. |
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": {
"delivery_type": [
"secure",
"non-secure"
],
"ip_version": [
"ipv4",
"ipv6"
],
"response_class": [
"3xx",
"0xx"
],
"response_code": [
"200",
"503"
],
"response_status": [
"success",
"error"
],
"traffic": [
"get_head_responses",
"put_post_responses"
]
}
}
GET /reporting-api/v1/reports/traffic-by-timeandresponse/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/traffic-by-timeandresponse/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 | 2019-10-08T13:40: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-08T14:00:00Z |
Specifies if unavailable reports should be shown. |
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, |
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= |
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": "traffic-by-timeandresponse",
"version": "1",
"outputType": "HIERARCHICAL",
"groupBy": [
"startdatetime",
"response_code"
],
"interval": "FIVE_MINUTES",
"start": "2019-10-08T13:40:00Z",
"end": "2019-10-08T14:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "delivery_type",
"values": [
"secure",
"non-secure"
]
},
{
"name": "ip_version",
"values": [
"ipv4",
"ipv6"
]
},
{
"name": "response_class",
"values": [
"3xx",
"1xx"
]
},
{
"name": "response_code",
"values": [
"201",
"403"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
},
{
"name": "traffic",
"values": [
"put_post_responses",
"put_post_requests"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "groupBy",
"label": "response_code"
},
{
"name": "edgeHitsPerSecond",
"label": "Edge Hits/Sec"
},
{
"name": "originHitsPerSecond",
"label": "Origin Hits/Sec"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2019-10-08T13:40:00Z",
"data": [
{
"response_code": "503",
"edgeHitsPerSecond": "4556.5574",
"originHitsPerSecond": "4798.522156"
},
{
"response_code": "100",
"edgeHitsPerSecond": "1091.386416",
"originHitsPerSecond": "4158.307916"
},
{
"response_code": "200",
"edgeHitsPerSecond": "4607.617607",
"originHitsPerSecond": "3714.640376"
},
{
"response_code": "403",
"edgeHitsPerSecond": "625.208813",
"originHitsPerSecond": "4378.655581"
}
]
},
{
"startdatetime": "2019-10-08T13:45:00Z",
"data": [
{
"response_code": "503",
"edgeHitsPerSecond": "2888.021197",
"originHitsPerSecond": "3183.27369"
},
{
"response_code": "100",
"edgeHitsPerSecond": "4058.53345",
"originHitsPerSecond": "4465.685569"
},
{
"response_code": "200",
"edgeHitsPerSecond": "922.058846",
"originHitsPerSecond": "4138.624358"
},
{
"response_code": "403",
"edgeHitsPerSecond": "4270.384611",
"originHitsPerSecond": "4498.839949"
}
]
},
{
"startdatetime": "2019-10-08T13:50:00Z",
"data": [
{
"response_code": "503",
"edgeHitsPerSecond": "3924.137112",
"originHitsPerSecond": "2637.43181"
},
{
"response_code": "100",
"edgeHitsPerSecond": "3790.762801",
"originHitsPerSecond": "2933.293945"
},
{
"response_code": "200",
"edgeHitsPerSecond": "401.719748",
"originHitsPerSecond": "472.46398"
},
{
"response_code": "403",
"edgeHitsPerSecond": "2047.58586",
"originHitsPerSecond": "2467.272274"
}
]
},
{
"startdatetime": "2019-10-08T13:55:00Z",
"data": [
{
"response_code": "503",
"edgeHitsPerSecond": "422.312807",
"originHitsPerSecond": "1371.18359"
},
{
"response_code": "100",
"edgeHitsPerSecond": "1420.840216",
"originHitsPerSecond": "3013.951549"
},
{
"response_code": "200",
"edgeHitsPerSecond": "4190.686747",
"originHitsPerSecond": "765.953772"
},
{
"response_code": "403",
"edgeHitsPerSecond": "2635.820488",
"originHitsPerSecond": "4243.167454"
}
]
}
],
"summaryStatistics": {}
}
Status 200
text/csv
Response Body:
#METADATA_START
name,traffic-by-timeandresponse
version,1
source,traffic-by-timeandresponse/versions/1
groupBy,startdatetime,response_code
start,2019-10-08T13:40:00Z
end,2019-10-08T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
delivery_type,secure,non-secure
ip_version,ipv4,ipv6
response_class,3xx,1xx
response_code,201,403
response_status,success,error
traffic,put_post_responses,put_post_requests
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,response_code,edgeHitsPerSecond,originHitsPerSecond
#COLUMNS_END
#DATA_START
2019-10-08T13:40:00Z,503,4556.5574,4798.522156
2019-10-08T13:40:00Z,100,1091.386416,4158.307916
2019-10-08T13:40:00Z,200,4607.617607,3714.640376
2019-10-08T13:40:00Z,403,625.208813,4378.655581
2019-10-08T13:45:00Z,503,2888.021197,3183.27369
2019-10-08T13:45:00Z,100,4058.53345,4465.685569
2019-10-08T13:45:00Z,200,922.058846,4138.624358
2019-10-08T13:45:00Z,403,4270.384611,4498.839949
2019-10-08T13:50:00Z,503,3924.137112,2637.43181
2019-10-08T13:50:00Z,100,3790.762801,2933.293945
2019-10-08T13:50:00Z,200,401.719748,472.46398
2019-10-08T13:50:00Z,403,2047.58586,2467.272274
2019-10-08T13:55:00Z,503,422.312807,1371.18359
2019-10-08T13:55:00Z,100,1420.840216,3013.951549
2019-10-08T13:55:00Z,200,4190.686747,765.953772
2019-10-08T13:55:00Z,403,2635.820488,4243.167454
#DATA_END
Get report details
This sample
Get a report type
operation gets the same information you need to run the
traffic-by-timeandresponse
report as provided in this reference documentation,
but available dynamically to your API client application.
GET /reporting-api/v1/reports/traffic-by-timeandresponse/versions/1
Status 200
application/json
Object type: ReportType
Download schema: data-row-schema.json
Response body:
{
"name": "traffic-by-timeandresponse",
"description": "Returns traffic data by HTTP response over time.",
"businessObjectName": "cpcode",
"version": 1,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"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 rate of origin requests for given objects and filters. ",
"label": "Origin Hits/Sec",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime",
"response_code"
],
"filters": [
{
"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": "response_code",
"type": "string",
"description": "An HTTP response status code, for example, 201. ",
"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": "traffic",
"type": "enum",
"description": "HTTP traffic to be included in the report data.",
"values": [
{
"value": "get_head_responses",
"description": "Response header traffic from GET operations."
},
{
"value": "put_post_requests",
"description": "Request traffic from PUT and POST 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": "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
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 92,
"links": [
{
"rel": "self",
"href": "/reporting-reports-executor-api/v1/reports/traffic-by-timeandresponse/versions/1"
},
{
"rel": "versions",
"href": "/reporting-reports-executor-api/v1/reports/traffic-by-timeandresponse/versions"
},
{
"rel": "all-reports",
"href": "/reporting-reports-executor-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-reports-executor-api/v1/reports/traffic-by-timeandresponse/versions/1/report-data"
}
]
}