bytes-by-time report

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.

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.
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.

Sample report

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

Object type: Query

Download schema: report-request-schema.json

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",
        "edgeBitsPerSecond",
        "edgeBitsPerSecondMax",
        "edgeBitsPerSecondMin",
        "edgeBytesSlope",
        "edgeBytesTotal",
        "midgressBitsPerSecond",
        "midgressBitsPerSecondMax",
        "midgressBitsPerSecondMin",
        "midgressBytesSlope",
        "midgressBytesTotal",
        "originBitsPerSecond",
        "originBitsPerSecondMax",
        "originBitsPerSecondMin",
        "originBytesSlope",
        "originBytesTotal"
    ],
    "filters": {
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "ip_version": [
            "ipv4",
            "ipv6"
        ],
        "traffic": [
            "put_post_responses",
            "get_head_responses"
        ]
    }
}

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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "bytes-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2019-09-27T13:40:00Z",
        "end": "2019-09-27T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "delivery_type",
                "values": [
                    "secure",
                    "non-secure"
                ]
            },
            {
                "name": "ip_version",
                "values": [
                    "ipv4",
                    "ipv6"
                ]
            },
            {
                "name": "traffic",
                "values": [
                    "put_post_responses",
                    "put_post_requests"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "bytesOffload",
                "label": "Offloaded Bytes"
            },
            {
                "name": "bytesOffloadAvg",
                "label": "Average Bytes Offload"
            },
            {
                "name": "bytesOffloadMax",
                "label": "Bytes Offload Maximum"
            },
            {
                "name": "bytesOffloadMin",
                "label": "Bytes Offload Minimum"
            },
            {
                "name": "bytesOffloadSlope",
                "label": "Bytes Offload Slope"
            },
            {
                "name": "edgeBitsPerSecond",
                "label": "Edge Bits/Sec"
            },
            {
                "name": "edgeBitsPerSecondMax",
                "label": "Edge Bits/Sec Maximum"
            },
            {
                "name": "edgeBitsPerSecondMin",
                "label": "Edge Bits/Sec Minimum"
            },
            {
                "name": "edgeBytesSlope",
                "label": "Edge Bytes Slope"
            },
            {
                "name": "edgeBytesTotal",
                "label": "Total Edge Bytes"
            },
            {
                "name": "midgressBitsPerSecond",
                "label": "Midgress Bits/Sec"
            },
            {
                "name": "midgressBitsPerSecondMax",
                "label": "Midgress Bits/Sec Maximum"
            },
            {
                "name": "midgressBitsPerSecondMin",
                "label": "Midgress Bits/Sec Minimum"
            },
            {
                "name": "midgressBytesSlope",
                "label": "Midgress Bytes Slope"
            },
            {
                "name": "midgressBytesTotal",
                "label": "Total Midgress Bytes"
            },
            {
                "name": "originBitsPerSecond",
                "label": "Origin Bits/Sec"
            },
            {
                "name": "originBitsPerSecondMax",
                "label": "Origin Bits/Sec Maximum"
            },
            {
                "name": "originBitsPerSecondMin",
                "label": "Origin Bits/Sec Minimum"
            },
            {
                "name": "originBytesSlope",
                "label": "Origin Bytes Slope"
            },
            {
                "name": "originBytesTotal",
                "label": "Total Origin Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2019-09-27T13:40:00Z",
            "bytesOffload": "10",
            "bytesOffloadAvg": "96",
            "bytesOffloadMax": "99",
            "bytesOffloadMin": "38",
            "bytesOffloadSlope": "1486",
            "edgeBitsPerSecond": "4777.658418",
            "edgeBitsPerSecondMax": "2140.02705",
            "edgeBitsPerSecondMin": "4945.868497",
            "edgeBytesSlope": "4770",
            "edgeBytesTotal": "2447",
            "midgressBitsPerSecond": "1333.647909",
            "midgressBitsPerSecondMax": "985.535204",
            "midgressBitsPerSecondMin": "2345.529492",
            "midgressBytesSlope": "4204",
            "midgressBytesTotal": "1484",
            "originBitsPerSecond": "1299.996378",
            "originBitsPerSecondMax": "10.708047",
            "originBitsPerSecondMin": "1578.215418",
            "originBytesSlope": "3957",
            "originBytesTotal": "167"
        },
        {
            "startdatetime": "2019-09-27T13:45:00Z",
            "bytesOffload": "12",
            "bytesOffloadAvg": "24",
            "bytesOffloadMax": "92",
            "bytesOffloadMin": "24",
            "bytesOffloadSlope": "3067",
            "edgeBitsPerSecond": "1274.11926",
            "edgeBitsPerSecondMax": "1682.795808",
            "edgeBitsPerSecondMin": "1464.166212",
            "edgeBytesSlope": "3428",
            "edgeBytesTotal": "4033",
            "midgressBitsPerSecond": "3558.994828",
            "midgressBitsPerSecondMax": "1566.918249",
            "midgressBitsPerSecondMin": "92.723667",
            "midgressBytesSlope": "669",
            "midgressBytesTotal": "2349",
            "originBitsPerSecond": "4095.303956",
            "originBitsPerSecondMax": "701.535548",
            "originBitsPerSecondMin": "1111.56944",
            "originBytesSlope": "4353",
            "originBytesTotal": "2765"
        },
        {
            "startdatetime": "2019-09-27T13:50:00Z",
            "bytesOffload": "42",
            "bytesOffloadAvg": "93",
            "bytesOffloadMax": "86",
            "bytesOffloadMin": "77",
            "bytesOffloadSlope": "2918",
            "edgeBitsPerSecond": "853.862246",
            "edgeBitsPerSecondMax": "4592.03961",
            "edgeBitsPerSecondMin": "3405.559429",
            "edgeBytesSlope": "1860",
            "edgeBytesTotal": "4465",
            "midgressBitsPerSecond": "3687.995213",
            "midgressBitsPerSecondMax": "4907.154062",
            "midgressBitsPerSecondMin": "3362.371853",
            "midgressBytesSlope": "2054",
            "midgressBytesTotal": "4071",
            "originBitsPerSecond": "2008.789843",
            "originBitsPerSecondMax": "4689.564512",
            "originBitsPerSecondMin": "3173.846142",
            "originBytesSlope": "1054",
            "originBytesTotal": "4315"
        },
        {
            "startdatetime": "2019-09-27T13:55:00Z",
            "bytesOffload": "4",
            "bytesOffloadAvg": "21",
            "bytesOffloadMax": "51",
            "bytesOffloadMin": "19",
            "bytesOffloadSlope": "1674",
            "edgeBitsPerSecond": "1056.177276",
            "edgeBitsPerSecondMax": "2004.192351",
            "edgeBitsPerSecondMin": "4450.85323",
            "edgeBytesSlope": "3562",
            "edgeBytesTotal": "255",
            "midgressBitsPerSecond": "1889.873213",
            "midgressBitsPerSecondMax": "4694.778644",
            "midgressBitsPerSecondMin": "1227.959787",
            "midgressBytesSlope": "1970",
            "midgressBytesTotal": "500",
            "originBitsPerSecond": "2690.682027",
            "originBitsPerSecondMax": "747.369169",
            "originBitsPerSecondMin": "4508.754319",
            "originBytesSlope": "2647",
            "originBytesTotal": "2479"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,bytes-by-time
version,1
source,bytes-by-time/versions/1
groupBy,startdatetime
start,2019-09-27T13:40:00Z
end,2019-09-27T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
delivery_type,secure,non-secure
ip_version,ipv4,ipv6
traffic,put_post_responses,put_post_requests
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,bytesOffload,bytesOffloadAvg,bytesOffloadMax,bytesOffloadMin,bytesOffloadSlope,edgeBitsPerSecond,edgeBitsPerSecondMax,edgeBitsPerSecondMin,edgeBytesSlope,edgeBytesTotal,midgressBitsPerSecond,midgressBitsPerSecondMax,midgressBitsPerSecondMin,midgressBytesSlope,midgressBytesTotal,originBitsPerSecond,originBitsPerSecondMax,originBitsPerSecondMin,originBytesSlope,originBytesTotal
#COLUMNS_END

#DATA_START
2019-09-27T13:40:00Z,10,96,99,38,1486,4777.658418,2140.02705,4945.868497,4770,2447,1333.647909,985.535204,2345.529492,4204,1484,1299.996378,10.708047,1578.215418,3957,167
2019-09-27T13:45:00Z,12,24,92,24,3067,1274.11926,1682.795808,1464.166212,3428,4033,3558.994828,1566.918249,92.723667,669,2349,4095.303956,701.535548,1111.56944,4353,2765
2019-09-27T13:50:00Z,42,93,86,77,2918,853.862246,4592.03961,3405.559429,1860,4465,3687.995213,4907.154062,3362.371853,2054,4071,2008.789843,4689.564512,3173.846142,1054,4315
2019-09-27T13:55:00Z,4,21,51,19,1674,1056.177276,2004.192351,4450.85323,3562,255,1889.873213,4694.778644,1227.959787,1970,500,2690.682027,747.369169,4508.754319,2647,2479
#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

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "bytes-by-time",
    "description": "Provides traffic volume data.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "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
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "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": "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": "ip_version",
            "type": "enum",
            "description": "The IP for which the report is shown.",
            "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/bytes-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/bytes-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/bytes-by-time/versions/1/report-data"
        }
    ]
}