The following shows how to generate the bytes-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
Provides traffic volume data.
This report allows you to configure the aggregation interval for each data record. Available interval
values are: MONTH
, WEEK
, DAY
, HOUR
, FIVE_MINUTES
.
If you use China CDN and want to monitor the offload metrics, use the new delivery/traffic/current report in the API v2.
Business object: cpcode
Data available for: 92 days
Available metrics
Metric | Description |
---|---|
Data metrics | |
bytesOffload | The volume that was served by Akamai as a percentage of total volume served for given objects and filters. |
bytesOffloadAvg | The average number of bytes that Akamai served as a percentage of total hits served for given objects and filters. |
bytesOffloadMax | The peak volume that was served by Akamai as a percentage of total volume served for given objects and filters. |
bytesOffloadMin | The lowest volume that was served by Akamai as a percentage of total volume served for given objects and filters. |
bytesOffloadSlope | Represents the overall change in volume that was served by Akamai as a percentage of total volume served for the given objects and filters, a positive number if increasing or a negative number if decreasing. |
edgeBitsPerSecond | The edge bandwidth for given objects and filters. |
edgeBitsPerSecondMax | The peak edge bandwidth for given objects and filters. |
edgeBitsPerSecondMin | The lowest edge bandwidth for given objects and filters. |
edgeBytesSlope | Represents the overall change in volume for edge traffic for given objects and filters, a positive number if increasing or a negative number if decreasing. |
edgeBytesTotal | The total volume of edge traffic for given objects and filters. |
midgressBitsPerSecond | The bandwidth between Akamai servers for given objects and filters. |
midgressBitsPerSecondMax | The peak bandwidth measurement between Akamai servers for given objects and filters. |
midgressBitsPerSecondMin | The lowest bandwidth measurement between Akamai servers for given objects and filters. |
midgressBytesSlope | Represents the overall change in traffic volume between Akamai servers over time for given objects and filters, a positive number if increasing or a negative number if decreasing. |
midgressBytesTotal | The total volume for the amount of internal API traffic exchanged between Akamai edge servers. |
originBitsPerSecond | The origin bandwidth for given objects and filters. |
originBitsPerSecondMax | The peak origin bandwidth for given objects and filters. |
originBitsPerSecondMin | The lowest origin bandwidth for given objects and filters. |
originBytesSlope | Represents the overall change in origin traffic volume over time for given objects and filters, a positive number if increasing or a negative number if decreasing. |
originBytesTotal | The total volume of origin traffic 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 | The IP for which the report is shown. |
ipv4 : IP address in v4 format. | ||
ipv6 : IP address in v6 format. | ||
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/bytes-by-time/versions/1/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/bytes-by-time/versions/1/report-data?start=2019-09-27T13%3A40%3A00Z&end=2019-09-27T14%3A00%3A00Z&interval=FIVE_MINUTES
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2019-09-27T13:40: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 | 2019-09-27T14: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. |
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": [
"bytesOffload",
"bytesOffloadAvg",
"bytesOffloadMax",
"bytesOffloadMin",
"bytesOffloadSlope",
"bytesOffloadTotal",
"edgeBitsPerSecond",
"edgeBitsPerSecondMax",
"edgeBitsPerSecondMin",
"edgeBytesSlope",
"edgeBytesTotal",
"maxEdgeBytes",
"maxMidgressBytes",
"maxOriginBytes",
"midgressBitsPerSecond",
"midgressBitsPerSecondMax",
"midgressBitsPerSecondMin",
"midgressBytesSlope",
"midgressBytesTotal",
"originBitsPerSecond",
"originBitsPerSecondMax",
"originBitsPerSecondMin",
"originBytesSlope",
"originBytesTotal"
],
"filters": {
"ca": [
"cacheable",
"non_cacheable"
],
"delivery_type": [
"secure",
"non-secure"
],
"http_version": [
"https1.1",
"http2"
],
"ip_version": [
"ipv4",
"ipv6"
],
"traffic": [
"get_head_responses",
"put_post_responses"
]
}
}
GET request
GET /reporting-api/v1/reports/bytes-by-time/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/bytes-by-time/versions/1/report-data?start=2019-09-27T13%3A40%3A00Z&end=2019-09-27T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=bytesOffload%2CbytesOffloadAvg&filters=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure%2Cip_version%3Dipv4%2Cip_version%3Dipv6
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2019-09-27T13:40: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 | 2019-09-27T14: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. |
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 | bytesOffload,bytesOffloadAvg | 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": "bytes-by-time",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"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": "traffic",
"values": [
"get_head_responses",
"put_post_responses"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "bytesOffload",
"label": "Offloaded Bytes"
},
{
"name": "edgeBitsPerSecond",
"label": "Edge Bits/Sec"
},
{
"name": "maxEdgeBytes",
"label": "Maximum Edge Bytes"
},
{
"name": "maxMidgressBytes",
"label": "Maximum Midgress Bytes"
},
{
"name": "maxOriginBytes",
"label": "Maximum Origin Bytes"
},
{
"name": "midgressBitsPerSecond",
"label": "Midgress Bits/Sec"
},
{
"name": "originBitsPerSecond",
"label": "Origin Bits/Sec"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2022-06-09T13:55:00Z",
"bytesOffload": "45",
"edgeBitsPerSecond": "4679.121878",
"maxEdgeBytes": "3510",
"maxMidgressBytes": "4998",
"maxOriginBytes": "380",
"midgressBitsPerSecond": "2402.72615",
"originBitsPerSecond": "4895.47813"
},
{
"startdatetime": "2022-06-09T14:00:00Z",
"bytesOffload": "79",
"edgeBitsPerSecond": "327.089297",
"maxEdgeBytes": "2188",
"maxMidgressBytes": "219",
"maxOriginBytes": "3431",
"midgressBitsPerSecond": "3119.357528",
"originBitsPerSecond": "2013.679847"
},
{
"startdatetime": "2022-06-09T14:05:00Z",
"bytesOffload": "0",
"edgeBitsPerSecond": "1353.759604",
"maxEdgeBytes": "4302",
"maxMidgressBytes": "702",
"maxOriginBytes": "2830",
"midgressBitsPerSecond": "885.123484",
"originBitsPerSecond": "3546.331022"
},
{
"startdatetime": "2022-06-09T14:10:00Z",
"bytesOffload": "22",
"edgeBitsPerSecond": "3218.030299",
"maxEdgeBytes": "3306",
"maxMidgressBytes": "4782",
"maxOriginBytes": "1955",
"midgressBitsPerSecond": "3464.62489",
"originBitsPerSecond": "2090.809777"
}
],
"summaryStatistics": {
"bytesOffloadAvg": {
"value": "63",
"details": {}
},
"bytesOffloadMax": {
"value": "79",
"details": {}
},
"bytesOffloadMin": {
"value": "68",
"details": {}
},
"bytesOffloadSlope": {
"value": "1979",
"details": {}
},
"bytesOffloadTotal": {
"value": "0",
"details": {}
},
"edgeBitsPerSecondMax": {
"value": "4956.123589",
"details": {}
},
"edgeBitsPerSecondMin": {
"value": "2285.976728",
"details": {}
},
"edgeBytesSlope": {
"value": "595",
"details": {}
},
"edgeBytesTotal": {
"value": "1223",
"details": {}
},
"midgressBitsPerSecondMax": {
"value": "178.862312",
"details": {}
},
"midgressBitsPerSecondMin": {
"value": "574.067335",
"details": {}
},
"midgressBytesSlope": {
"value": "625",
"details": {}
},
"midgressBytesTotal": {
"value": "1366",
"details": {}
},
"originBitsPerSecondMax": {
"value": "177.129165",
"details": {}
},
"originBitsPerSecondMin": {
"value": "1639.809681",
"details": {}
},
"originBytesSlope": {
"value": "4074",
"details": {}
},
"originBytesTotal": {
"value": "2580",
"details": {}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,bytes-by-time
version,1
source,bytes-by-time/versions/1
groupBy,startdatetime
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
traffic,get_head_responses,put_post_responses
#METADATA_END
#SUMMARYSTATISTICS_START
bytesOffloadAvg,63
bytesOffloadMax,79
bytesOffloadMin,68
bytesOffloadSlope,1979
bytesOffloadTotal,0
edgeBitsPerSecondMax,4956.123589
edgeBitsPerSecondMin,2285.976728
edgeBytesSlope,595
edgeBytesTotal,1223
midgressBitsPerSecondMax,178.862312
midgressBitsPerSecondMin,574.067335
midgressBytesSlope,625
midgressBytesTotal,1366
originBitsPerSecondMax,177.129165
originBitsPerSecondMin,1639.809681
originBytesSlope,4074
originBytesTotal,2580
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,bytesOffload,edgeBitsPerSecond,maxEdgeBytes,maxMidgressBytes,maxOriginBytes,midgressBitsPerSecond,originBitsPerSecond
#COLUMNS_END
#DATA_START
2022-06-09T13:55:00Z,45,4679.121878,3510,4998,380,2402.72615,4895.47813
2022-06-09T14:00:00Z,79,327.089297,2188,219,3431,3119.357528,2013.679847
2022-06-09T14:05:00Z,0,1353.759604,4302,702,2830,885.123484,3546.331022
2022-06-09T14:10:00Z,22,3218.030299,3306,4782,1955,3464.62489,2090.809777
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the bytes-by-time
report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/bytes-by-time/versions/1
Status 200 application/json
Response body:
{
"name": "bytes-by-time",
"description": "Provides traffic volume data.",
"businessObjectName": "cpcode",
"version": 1,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"supportsPagination": false,
"outputType": "FLAT",
"requiredProducts": [
"Basic Traffic Reports"
],
"requiredRoles": [
"Reports - All privileges",
"Reports - View only",
"OTA App User"
],
"available": true,
"metrics": [
{
"name": "bytesOffload",
"description": "The volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
"label": "Offloaded Bytes",
"unit": "RATIO",
"summaryStatistic": false
},
{
"name": "bytesOffloadAvg",
"description": "The average number of bytes that Akamai served as a percentage of total hits served for given objects and filters.",
"label": "Average Bytes Offload",
"unit": "RATIO",
"summaryStatistic": true
},
{
"name": "bytesOffloadMax",
"description": "The peak volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
"label": "Bytes Offload Maximum",
"unit": "RATIO",
"summaryStatistic": true
},
{
"name": "bytesOffloadMin",
"description": "The lowest volume that was served by Akamai as a percentage of total volume served for given objects and filters.",
"label": "Bytes Offload Minimum",
"unit": "RATIO",
"summaryStatistic": true
},
{
"name": "bytesOffloadSlope",
"description": "Represents the overall change in volume that was served by Akamai as a percentage of total volume served for the given objects and filters, a positive number if increasing or a negative number if decreasing.",
"label": "Bytes Offload Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "edgeBitsPerSecond",
"description": "The edge bandwidth for given objects and filters.",
"label": "Edge Bits/Sec",
"unit": "BIT_PER_SECOND",
"summaryStatistic": false
},
{
"name": "edgeBitsPerSecondMax",
"description": "The peak edge bandwidth for given objects and filters.",
"label": "Edge Bits/Sec Maximum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "edgeBitsPerSecondMin",
"description": "The lowest edge bandwidth for given objects and filters.",
"label": "Edge Bits/Sec Minimum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "edgeBytesSlope",
"description": "Represents the overall change in volume for edge traffic for given objects and filters, a positive number if increasing or a negative number if decreasing.",
"label": "Edge Bytes Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "edgeBytesTotal",
"description": "The total volume of edge traffic for given objects and filters.",
"label": "Total Edge Bytes",
"unit": "BYTE",
"summaryStatistic": true
},
{
"name": "midgressBitsPerSecond",
"description": "The bandwidth between Akamai servers for given objects and filters.",
"label": "Midgress Bits/Sec",
"unit": "BIT_PER_SECOND",
"summaryStatistic": false
},
{
"name": "midgressBitsPerSecondMax",
"description": "The peak bandwidth measurement between Akamai servers for given objects and filters.",
"label": "Midgress Bits/Sec Maximum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "midgressBitsPerSecondMin",
"description": "The lowest bandwidth measurement between Akamai servers for given objects and filters.",
"label": "Midgress Bits/Sec Minimum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "midgressBytesSlope",
"description": "Represents the overall change in traffic volume between Akamai servers over time for given objects and filters, a positive number if increasing or a negative number if decreasing.",
"label": "Midgress Bytes Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "midgressBytesTotal",
"description": "The total volume for the amount of internal API traffic exchanged between Akamai edge servers.",
"label": "Total Midgress Bytes",
"unit": "BYTE",
"summaryStatistic": true
},
{
"name": "originBitsPerSecond",
"description": "The origin bandwidth for given objects and filters.",
"label": "Origin Bits/Sec",
"unit": "BIT_PER_SECOND",
"summaryStatistic": false
},
{
"name": "originBitsPerSecondMax",
"description": "The peak origin bandwidth for given objects and filters. ",
"label": "Origin Bits/Sec Maximum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "originBitsPerSecondMin",
"description": "The lowest origin bandwidth for given objects and filters.",
"label": "Origin Bits/Sec Minimum",
"unit": "BIT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "originBytesSlope",
"description": "Represents the overall change in origin traffic volume over time for given objects and filters, a positive number if increasing or a negative number if decreasing. ",
"label": "Origin Bytes Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "originBytesTotal",
"description": "The total volume of origin traffic for given objects and filters.",
"label": "Total Origin Bytes",
"unit": "BYTE",
"summaryStatistic": true
},
{
"name": "bytesOffloadTotal",
"description": "Bytes offload total.",
"label": "Bytes Offload Total",
"unit": "RATIO",
"summaryStatistic": true
},
{
"name": "maxMidgressBytes",
"description": "Maximum midgress bytes.",
"label": "Maximum Midgress Bytes",
"unit": "BYTE",
"summaryStatistic": false
},
{
"name": "maxEdgeBytes",
"description": "Maximum Edge bytes.",
"label": "Maximum Edge Bytes",
"unit": "BYTE",
"summaryStatistic": false
},
{
"name": "maxOriginBytes",
"description": "Maximum Origin bytes.",
"label": "Maximum Origin Bytes",
"unit": "BYTE",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime"
],
"filters": [
{
"name": "ip_version",
"type": "enum",
"description": "Optional. Supported array values are ipv4 and ipv6. If no IP version is selected, the report shows data for both 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": "Reponse 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": "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": "delivery_type",
"type": "enum",
"description": "Distinguishes secure from non-secure traffic. Optional. No selection returns both secure and 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/bytes-by-time/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/bytes-by-time/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/bytes-by-time/versions/1/report-data"
}
]
}