The following shows how to generate the todaytraffic-by-time-rl
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
This report allows you to configure the aggregation interval for each data record.
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: 3 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
Metric | Description |
---|---|
Data metrics | |
bytesOffload | The volume that was served by Akamai as a percentage of total volume served for given objects and filters. |
edgeBitsPerSecond | The edge bandwidth for given objects and filters. |
edgeHitsPerSecond | The number of edge requests per second for given objects and filters. |
hitsOffload | The number of hits that Akamai served as a percentage of total hits served for given objects and filters. |
midgressBitsPerSecond | The bandwidth between Akamai servers for given objects and filters. |
midgressHitsPerSecond | The number of requests between Akamai servers per second for given objects and filters. |
originBitsPerSecond | The origin bandwidth for given objects and filters. |
originHitsPerSecond | The number of origin requests per second for given objects and filters.. |
Summary metrics | |
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. |
bytesOffloadTotal | Bytes offload total. |
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. |
edgeHitsPerSecondMax | The peak number of edge requests per second for given objects and filters. |
edgeHitsPerSecondMin | The lowest number of edge requests per second for given objects and filters. |
edgeHitsSlope | Represents the overall change in the number of edge requests for given objects and filters, a positive number if increasing or a negative number if decreasing. |
edgeHitsTotal | The total number of edge requests for given objects and filters. |
hitsOffloadAvg | The average number of hits that Akamai served as a percentage of total hits served for given objects and filters. |
hitsOffloadMax | The peak number of hits that Akamai served as a percentage of total hits served for given objects and filters. |
hitsOffloadMin | The lowest number of hits that Akamai served as a percentage of total hits served for given objects and filters. |
hitsOffloadSlope | The overall change in number of hits that were served by Akamai as a percentage of total hits served for given objects and filters, a positive number if increasing or a negative number if decreasing. |
hitsOffloadTotal | Hits offload total. |
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. |
midgressHitsPerSecondMax | The peak number of requests between Akamai servers per second for given objects and filters. |
midgressHitsPerSecondMin | The lowest number of requests between Akamai servers per second for given objects and filters. |
midgressHitsSlope | 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. |
midgressHitsTotal | All hits with all response codes delivered from Akamai's Tiered Distribution network, that is bytes served from the Akamai Tiered Distribution infrastructure to edge servers. |
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. |
originHitsPerSecondMax | The peak number of origin requests per second for given objects and filters. |
originHitsPerSecondMin | The lowest number of origin requests per second for given objects and filters. |
originHitsSlope | Represents the overall change in the number of requests to origin over time for given objects and filters, a positive number if increasing or a negative number if decreasing. |
originHitsTotal | The total number of origin requests for given objects and filters. |
Available filters
Filter | Type | Description |
---|---|---|
Optional filters | ||
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. |
POST request
POST /reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1/report-data{?start,end,interval}
Sample: /reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2020-06-26T13: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 | 2020-06-26T14: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",
"edgeHitsPerSecond",
"edgeHitsPerSecondMax",
"edgeHitsPerSecondMin",
"edgeHitsSlope",
"edgeHitsTotal",
"hitsOffload",
"hitsOffloadAvg",
"hitsOffloadMax",
"hitsOffloadMin",
"hitsOffloadSlope",
"hitsOffloadTotal",
"midgressBitsPerSecond",
"midgressBitsPerSecondMax",
"midgressBitsPerSecondMin",
"midgressBytesSlope",
"midgressBytesTotal",
"midgressHitsPerSecond",
"midgressHitsPerSecondMax",
"midgressHitsPerSecondMin",
"midgressHitsSlope",
"midgressHitsTotal",
"originBitsPerSecond",
"originBitsPerSecondMax",
"originBitsPerSecondMin",
"originBytesSlope",
"originBytesTotal",
"originHitsPerSecond",
"originHitsPerSecondMax",
"originHitsPerSecondMin",
"originHitsSlope",
"originHitsTotal"
],
"filters": {
"response_class": [
"3xx",
"2xx"
],
"response_status": [
"success",
"error"
]
}
}
GET request
GET /reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=bytesOffload%2CbytesOffloadAvg&filters=response_class%3D4xx%2Cresponse_class%3D2xx%2Cresponse_status%3Dsuccess%2Cresponse_status%3Derror
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 | 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 | response_class=4xx,response_class=2xx,response_status=success,response_status=error | 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": "todaytraffic-by-time-rl",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"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": [
"0xx",
"5xx"
]
},
{
"name": "response_status",
"values": [
"success",
"error"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "bytesOffload",
"label": "Offloaded Bytes"
},
{
"name": "edgeBitsPerSecond",
"label": "Edge Bits/Sec"
},
{
"name": "edgeHitsPerSecond",
"label": "Edge Hits/Sec"
},
{
"name": "hitsOffload",
"label": "Offloaded Hits"
},
{
"name": "midgressBitsPerSecond",
"label": "Midgress Bits/Sec"
},
{
"name": "midgressHitsPerSecond",
"label": "Midgress Hits/Sec"
},
{
"name": "originBitsPerSecond",
"label": "Origin Bits/Sec"
},
{
"name": "originHitsPerSecond",
"label": "Origin Hits/Sec"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2020-06-26T13:40:00Z",
"bytesOffload": "82",
"edgeBitsPerSecond": "2399.982382",
"edgeHitsPerSecond": "4776.601289",
"hitsOffload": "32",
"midgressBitsPerSecond": "954.077335",
"midgressHitsPerSecond": "2626.74117",
"originBitsPerSecond": "4675.883487",
"originHitsPerSecond": "3184.297076"
},
{
"startdatetime": "2020-06-26T13:45:00Z",
"bytesOffload": "0",
"edgeBitsPerSecond": "3202.452243",
"edgeHitsPerSecond": "2885.174067",
"hitsOffload": "32",
"midgressBitsPerSecond": "3162.622341",
"midgressHitsPerSecond": "182.080402",
"originBitsPerSecond": "3066.280403",
"originHitsPerSecond": "1711.689686"
},
{
"startdatetime": "2020-06-26T13:50:00Z",
"bytesOffload": "75",
"edgeBitsPerSecond": "1379.354803",
"edgeHitsPerSecond": "293.327174",
"hitsOffload": "27",
"midgressBitsPerSecond": "4858.393359",
"midgressHitsPerSecond": "3757.155386",
"originBitsPerSecond": "4474.077399",
"originHitsPerSecond": "3901.509606"
},
{
"startdatetime": "2020-06-26T13:55:00Z",
"bytesOffload": "52",
"edgeBitsPerSecond": "2344.259829",
"edgeHitsPerSecond": "1547.163826",
"hitsOffload": "36",
"midgressBitsPerSecond": "1730.881337",
"midgressHitsPerSecond": "2165.093875",
"originBitsPerSecond": "2665.327637",
"originHitsPerSecond": "2509.771465"
}
],
"summaryStatistics": {
"bytesOffloadAvg": {
"value": "10",
"details": {}
},
"bytesOffloadMax": {
"value": "77",
"details": {}
},
"bytesOffloadMin": {
"value": "25",
"details": {}
},
"bytesOffloadSlope": {
"value": "2088",
"details": {}
},
"bytesOffloadTotal": {
"value": "28",
"details": {}
},
"edgeBitsPerSecondMax": {
"value": "4724.080811",
"details": {}
},
"edgeBitsPerSecondMin": {
"value": "3852.496657",
"details": {}
},
"edgeBytesSlope": {
"value": "28",
"details": {}
},
"edgeBytesTotal": {
"value": "2960",
"details": {}
},
"edgeHitsPerSecondMax": {
"value": "4869.073394",
"details": {}
},
"edgeHitsPerSecondMin": {
"value": "2768.635833",
"details": {}
},
"edgeHitsSlope": {
"value": "1851",
"details": {}
},
"edgeHitsTotal": {
"value": "459",
"details": {}
},
"hitsOffloadAvg": {
"value": "33",
"details": {}
},
"hitsOffloadMax": {
"value": "1",
"details": {}
},
"hitsOffloadMin": {
"value": "70",
"details": {}
},
"hitsOffloadSlope": {
"value": "4654",
"details": {}
},
"hitsOffloadTotal": {
"value": "34",
"details": {}
},
"midgressBitsPerSecondMax": {
"value": "1445.165795",
"details": {}
},
"midgressBitsPerSecondMin": {
"value": "2359.875135",
"details": {}
},
"midgressBytesSlope": {
"value": "4777",
"details": {}
},
"midgressBytesTotal": {
"value": "3",
"details": {}
},
"midgressHitsPerSecondMax": {
"value": "4209.826701",
"details": {}
},
"midgressHitsPerSecondMin": {
"value": "2243.675264",
"details": {}
},
"midgressHitsSlope": {
"value": "3690",
"details": {}
},
"midgressHitsTotal": {
"value": "2474",
"details": {}
},
"originBitsPerSecondMax": {
"value": "3732.327836",
"details": {}
},
"originBitsPerSecondMin": {
"value": "2818.778869",
"details": {}
},
"originBytesSlope": {
"value": "2255",
"details": {}
},
"originBytesTotal": {
"value": "4039",
"details": {}
},
"originHitsPerSecondMax": {
"value": "2099.801345",
"details": {}
},
"originHitsPerSecondMin": {
"value": "3849.179024",
"details": {}
},
"originHitsSlope": {
"value": "147",
"details": {}
},
"originHitsTotal": {
"value": "3522",
"details": {}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,todaytraffic-by-time-rl
version,1
source,todaytraffic-by-time-rl/versions/1
groupBy,startdatetime
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,0xx,5xx
response_status,success,error
#METADATA_END
#SUMMARYSTATISTICS_START
bytesOffloadAvg,10
bytesOffloadMax,77
bytesOffloadMin,25
bytesOffloadSlope,2088
bytesOffloadTotal,28
edgeBitsPerSecondMax,4724.080811
edgeBitsPerSecondMin,3852.496657
edgeBytesSlope,28
edgeBytesTotal,2960
edgeHitsPerSecondMax,4869.073394
edgeHitsPerSecondMin,2768.635833
edgeHitsSlope,1851
edgeHitsTotal,459
hitsOffloadAvg,33
hitsOffloadMax,1
hitsOffloadMin,70
hitsOffloadSlope,4654
hitsOffloadTotal,34
midgressBitsPerSecondMax,1445.165795
midgressBitsPerSecondMin,2359.875135
midgressBytesSlope,4777
midgressBytesTotal,3
midgressHitsPerSecondMax,4209.826701
midgressHitsPerSecondMin,2243.675264
midgressHitsSlope,3690
midgressHitsTotal,2474
originBitsPerSecondMax,3732.327836
originBitsPerSecondMin,2818.778869
originBytesSlope,2255
originBytesTotal,4039
originHitsPerSecondMax,2099.801345
originHitsPerSecondMin,3849.179024
originHitsSlope,147
originHitsTotal,3522
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,bytesOffload,edgeBitsPerSecond,edgeHitsPerSecond,hitsOffload,midgressBitsPerSecond,midgressHitsPerSecond,originBitsPerSecond,originHitsPerSecond
#COLUMNS_END
#DATA_START
2020-06-26T13:40:00Z,82,2399.982382,4776.601289,32,954.077335,2626.74117,4675.883487,3184.297076
2020-06-26T13:45:00Z,0,3202.452243,2885.174067,32,3162.622341,182.080402,3066.280403,1711.689686
2020-06-26T13:50:00Z,75,1379.354803,293.327174,27,4858.393359,3757.155386,4474.077399,3901.509606
2020-06-26T13:55:00Z,52,2344.259829,1547.163826,36,1730.881337,2165.093875,2665.327637,2509.771465
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the todaytraffic-by-time-rl
report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1
Status 200 application/json
Response body:
{
"name": "todaytraffic-by-time-rl",
"description": "This report allows you to configure the aggregation interval for each data record.",
"businessObjectName": "cpcode",
"version": 1,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"outputType": "FLAT",
"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": "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": "bytesOffloadTotal",
"description": "Bytes offload total.",
"label": "Total Bytes Offload",
"unit": "RATIO",
"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": "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": "edgeHitsPerSecondMax",
"description": "The peak number of edge requests per second for given objects and filters.",
"label": "Edge Hits/Sec Maximum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "edgeHitsPerSecondMin",
"description": "The lowest number of edge requests per second for given objects and filters.",
"label": "Edge Hits/Sec Minimum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "edgeHitsSlope",
"description": "Represents the overall change in the number of edge requests for given objects and filters, a positive number if increasing or a negative number if decreasing.",
"label": "Edge Hits Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "edgeHitsTotal",
"description": "The total number of edge requests for given objects and filters.",
"label": "Total Edge Hits",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "hitsOffload",
"description": "The 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": "hitsOffloadAvg",
"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": "hitsOffloadMax",
"description": "The peak 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": "hitsOffloadMin",
"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": "hitsOffloadSlope",
"description": "The overall change in number of hits that were served by Akamai 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": "hitsOffloadTotal",
"description": "Hits offload total.",
"label": "Total Hits Offload",
"unit": "RATIO",
"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": "midgressHitsPerSecond",
"description": "The number of requests between Akamai servers per second for given objects and filters.",
"label": "Midgress Hits/Sec",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": false
},
{
"name": "midgressHitsPerSecondMax",
"description": "The peak number of requests between Akamai servers per second for given objects and filters.",
"label": "Midgress Hits/Sec Maximum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "midgressHitsPerSecondMin",
"description": "The lowest number of requests between Akamai servers per second for given objects and filters.",
"label": "Midgress Hits/Sec Minimum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "midgressHitsSlope",
"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 Hits Slope",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "midgressHitsTotal",
"description": "All hits with all response codes delivered from Akamai's Tiered Distribution network, that is bytes served from the Akamai Tiered Distribution infrastructure to edge servers.",
"label": "Total Midgress Hits",
"unit": "COUNT",
"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": "originHitsPerSecond",
"description": "The number of origin requests per second for given objects and filters..",
"label": "Origin Hits/Sec",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": false
},
{
"name": "originHitsPerSecondMax",
"description": "The peak number of origin requests per second for given objects and filters.",
"label": "Origin Hits/Sec Maximum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "originHitsPerSecondMin",
"description": "The lowest number of origin requests per second for given objects and filters.",
"label": "Origin Hits/Sec Minimum",
"unit": "COUNT_PER_SECOND",
"summaryStatistic": true
},
{
"name": "originHitsSlope",
"description": "Represents the overall change in the number of requests to origin over time 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": "originHitsTotal",
"description": "The total number of origin requests for given objects and filters.",
"label": "Total Origin Hits",
"unit": "COUNT",
"summaryStatistic": true
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime"
],
"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": 3,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/todaytraffic-by-time-rl/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/todaytraffic-by-time-rl/versions/1/report-data"
}
]
}