bytes-by-cpcode

The following shows how to generate the bytes-by-cpcode 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 volume data by CP code.

Business object: cpcode

Data available for: 92 days

Available metrics

MetricDescription
Data metrics
bytesOffloadThe volume that was served by Akamai as a percentage of total volume served for given objects and filters.
edgeBytesThe volume for the traffic delivered from Akamai to the end user.
midgressBytesThe volume for traffic exchanged between Akamai edge servers.
originBytesThe volume for traffic from the origin.

Available filters

FilterTypeDescription
Optional filters
delivery_typeEnumerationDistinguishes secure from non-secure traffic.
secure: Secure traffic.
non_secure: Non-secure traffic.
ip_versionEnumerationThe IP for which the report is shown.
ipv4: IP address in v4 format.
ipv6: IP address in v6 format.
trafficEnumerationHTTP 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-cpcode/versions/1/report-data{?start,​end}

Sample: /reporting-api/v1/reports/bytes-by-cpcode/versions/1/report-data?start​=2019-08-01T00%3A00%3A00Z​&end​=2019-09-01T00%3A00%3A00Z

Query parameters

ParameterTypeSampleDescription
Required
startString2019-08-01T00:00:00ZSpecifies 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.
endString2019-09-01T00:00:00ZSpecifies if unavailable reports should be shown.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of cpcode values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of arraysSpecifies 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",
        "edgeBytes",
        "midgressBytes",
        "originBytes"
    ],
    "filters": {
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "ip_version": [
            "ipv4",
            "ipv6"
        ],
        "traffic": [
            "put_post_responses",
            "put_post_requests"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/bytes-by-cpcode/versions/1/report-data{?start,​end,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/bytes-by-cpcode/versions/1/report-data?start​=2019-08-01T00%3A00%3A00Z​&end​=2019-09-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=bytesOffload%2CedgeBytes​&filters​=delivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure%2Cip_version%3Dipv4%2Cip_version%3Dipv6

Query parameters

ParameterTypeSampleDescription
Required
startString2019-08-01T00:00:00ZSpecifies 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.
endString2019-09-01T00:00:00ZSpecifies if unavailable reports should be shown.
Optional
allObjectIdsBooleantrueAs 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.
objectIdsString55232,​23433,​32433As 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.
metricsStringbytesOffload,​edgeBytesSpecifies 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.
filtersStringdelivery_type=​secure,​delivery_type=​non-secure,​ip_version=​ipv4,​ip_version=​ipv6Specifies 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-cpcode",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "cpcode"
        ],
        "start": "2019-08-01T00:00:00Z",
        "end": "2019-09-01T00: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": "cpcode"
            },
            {
                "name": "bytesOffload",
                "label": "Offloaded  Bytes"
            },
            {
                "name": "edgeBytes",
                "label": "Edge  Bytes"
            },
            {
                "name": "midgressBytes",
                "label": "Midgress Bytes"
            },
            {
                "name": "originBytes",
                "label": "Origin  Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "cpcode": "23451",
            "bytesOffload": "48",
            "edgeBytes": "4422",
            "midgressBytes": "1168",
            "originBytes": "2026"
        },
        {
            "cpcode": "12345",
            "bytesOffload": "79",
            "edgeBytes": "401",
            "midgressBytes": "3788",
            "originBytes": "2149"
        },
        {
            "cpcode": "34512",
            "bytesOffload": "4",
            "edgeBytes": "2440",
            "midgressBytes": "286",
            "originBytes": "1700"
        },
        {
            "cpcode": "51234",
            "bytesOffload": "42",
            "edgeBytes": "135",
            "midgressBytes": "4036",
            "originBytes": "2800"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​bytes-by-cpcode
version,​1
source,​bytes-by-cpcode/versions/1
groupBy,​cpcode
start,​2019-08-01T00:00:00Z
end,​2019-09-01T00:00:00Z
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
cpcode,​bytesOffload,​edgeBytes,​midgressBytes,​originBytes
#COLUMNS_END

#DATA_START
23451,​48,​4422,​1168,​2026
12345,​79,​401,​3788,​2149
34512,​4,2440,​286,​1700
51234,​42,​135,​4036,​2800
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the bytes-by-cpcode report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/bytes-by-cpcode/versions/1

Status 200 application/json

Response body:

{
    "name": "bytes-by-cpcode",
    "description": "Returns volume data by CP code. ",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": 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": "edgeBytes",
            "description": "The volume for the traffic delivered from Akamai to the end user.",
            "label": "Edge  Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "midgressBytes",
            "description": "The volume for traffic exchanged between Akamai edge servers.",
            "label": "Midgress Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        },
        {
            "name": "originBytes",
            "description": "The volume for traffic from the origin.",
            "label": "Origin  Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "cpcode"
    ],
    "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-api/v1/reports/bytes-by-cpcode/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/bytes-by-cpcode/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/bytes-by-cpcode/versions/1/report-data"
        }
    ]
}