bytes-by-tophostnameandtime

The following shows how to generate the bytes-by-tophostnameandtime 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

Maximum edge bytes returned by top hostname and 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

MetricDescription
Data metrics
maxEdgeBytesMaximum edge bytes.

Available filters

FilterTypeDescription
Optional filters
caEnumerationIndicates whether content is storable.
non_cacheable: Can't be stored (identified as 'no-store' or has a 0 TTL) and will always trigger an origin request.
cacheable: Can be stored after an initial request for faster future delivery.
delivery_typeEnumerationDistinguishes secure from non-secure traffic.
secure: Secure traffic.
non_secure: Non-secure traffic.
hostname_containStringHostname contains the specified string.
hostname_end_‚ÄčwithStringHostname ends with the specified string.
hostname_exact_‚ÄčmatchStringHostname is an exact match for the specified string.
hostname_matchRegexpHostname is an exact match for the specified string.
hostname_not_‚ÄčcontainStringHostname does not contain the specified string.
hostname_not_‚Äčend_‚ÄčwithStringHostname does not end with the specified string.
hostname_not_‚ÄčmatchRegexpHostname does not match the specified string.
hostname_not_‚Äčstart_‚ÄčwithStringHostname does not start with the specified string.
hostname_start_‚ÄčwithStringHostname starts with the specified string.
http_versionEnumerationHTTP version.
https1.1: https1.1
http2: http2
http3: http3
http1.1: http1.1
ip_versionEnumerationIP for which the report is shown.
ipv4: IP address in v4 format.
ipv6: IP address in v6 format.
response_classEnumerationA 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_codeStringAn HTTP response status code, for example, 201.
response_statusEnumerationAn indicator of whether the HTTP response resulted in success or an error.
success: Successful HTTP response status.
error: Error HTTP response status.
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-tophostnameandtime/versions/1/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/bytes-by-tophostnameandtime/versions/1/report-data?start=2022-11-15T13%3A55%3A00Z&end=2022-11-15T14%3A15%3A00Z&interval=FIVE_MINUTES

For other granularity, you need to adjust start and end dates:

Sample with longer interval: /reporting-api/v1/reports/bytes-by-tophostnameandtime/versions/1/report-data?start=2022-07-01&end=2022-11-01&interval=MONTH

Query parameters

ParameterTypeSampleDescription
Required
startString2022-11-15T13:55:00ZSpecifies 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.
endString2022-11-15T14:15: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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

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": [
        "maxEdgeBytes"
    ],
    "filters": {
        "ca": [
            "cacheable",
            "non_cacheable"
        ],
        "delivery_type": [
            "secure",
            "non-secure"
        ],
        "hostname_contain": [
            "m.example.com",
            "www.example.com"
        ],
        "hostname_end_with": [
            "m.example.com",
            "blog.example.com"
        ],
        "hostname_exact_match": [
            "img.example.com",
            "blog.example.com"
        ],
        "hostname_match": [
            "www.example.com",
            "img.example.com"
        ],
        "hostname_not_contain": [
            "img.example.com",
            "blog.example.com"
        ],
        "hostname_not_end_with": [
            "m.example.com",
            "img.example.com"
        ],
        "hostname_not_match": [
            "img.example.com",
            "www.example.com"
        ],
        "hostname_not_start_with": [
            "www.example.com",
            "m.example.com"
        ],
        "hostname_start_with": [
            "www.example.com",
            "blog.example.com"
        ],
        "http_version": [
            "http3",
            "http2"
        ],
        "ip_version": [
            "ipv4",
            "ipv6"
        ],
        "response_class": [
            "5xx",
            "2xx"
        ],
        "response_code": [
            "503",
            "100"
        ],
        "response_status": [
            "success",
            "error"
        ],
        "traffic": [
            "put_post_requests",
            "get_head_responses"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/bytes-by-tophostnameandtime/versions/1/report-data?start=2022-11-15T13%3A55%3A00Z&end=2022-11-15T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=maxEdgeBytes&filters=ca%3Dcacheable%2Cca%3Dnon_cacheable%2Cdelivery_type%3Dsecure%2Cdelivery_type%3Dnon-secure

Query parameters

ParameterTypeSampleDescription
Required
startString2022-11-15T13:55:00ZSpecifies 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.
endString2022-11-15T14:15: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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
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.
metricsStringmaxEdgeBytesSpecifies 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.
filtersStringca=cacheable,‚Äčca=‚Äčnon_‚Äčcacheable,‚Äčdelivery_‚Äčtype=‚Äčsecure,‚Äčdelivery_‚Äčtype=‚Äčnon-secureSpecifies 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-tophostnameandtime",
        "version": "1",
        "outputType": "HIERARCHICAL",
        "groupBy": [
            "startdatetime",
            "hostname"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2022-11-15T13:55:00Z",
        "end": "2022-11-15T14:15:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "ca",
                "values": [
                    "cacheable",
                    "non_cacheable"
                ]
            },
            {
                "name": "delivery_type",
                "values": [
                    "secure",
                    "non-secure"
                ]
            },
            {
                "name": "hostname_contain",
                "values": [
                    "m.example.com",
                    "www.example.com"
                ]
            },
            {
                "name": "hostname_end_with",
                "values": [
                    "m.example.com",
                    "www.example.com"
                ]
            },
            {
                "name": "hostname_exact_match",
                "values": [
                    "blog.example.com",
                    "www.example.com"
                ]
            },
            {
                "name": "hostname_match",
                "values": [
                    "img.example.com",
                    "blog.example.com"
                ]
            },
            {
                "name": "hostname_not_contain",
                "values": [
                    "blog.example.com",
                    "img.example.com"
                ]
            },
            {
                "name": "hostname_not_end_with",
                "values": [
                    "img.example.com",
                    "m.example.com"
                ]
            },
            {
                "name": "hostname_not_match",
                "values": [
                    "blog.example.com",
                    "img.example.com"
                ]
            },
            {
                "name": "hostname_not_start_with",
                "values": [
                    "blog.example.com",
                    "m.example.com"
                ]
            },
            {
                "name": "hostname_start_with",
                "values": [
                    "www.example.com",
                    "m.example.com"
                ]
            },
            {
                "name": "http_version",
                "values": [
                    "http1.1",
                    "http2"
                ]
            },
            {
                "name": "ip_version",
                "values": [
                    "ipv4",
                    "ipv6"
                ]
            },
            {
                "name": "response_class",
                "values": [
                    "1xx",
                    "0xx"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "201",
                    "500"
                ]
            },
            {
                "name": "response_status",
                "values": [
                    "success",
                    "error"
                ]
            },
            {
                "name": "traffic",
                "values": [
                    "put_post_responses",
                    "get_head_responses"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "groupBy",
                "label": "hostname"
            },
            {
                "name": "maxEdgeBytes",
                "label": "Maximum Edge Bytes"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2022-11-15T13:55:00Z",
            "data": [
                {
                    "hostname": "www.example.com",
                    "maxEdgeBytes": "482"
                },
                {
                    "hostname": "m.example.com",
                    "maxEdgeBytes": "759"
                },
                {
                    "hostname": "blog.example.com",
                    "maxEdgeBytes": "338"
                },
                {
                    "hostname": "img.example.com",
                    "maxEdgeBytes": "974"
                }
            ]
        },
        {
            "startdatetime": "2022-11-15T14:00:00Z",
            "data": [
                {
                    "hostname": "www.example.com",
                    "maxEdgeBytes": "4321"
                },
                {
                    "hostname": "m.example.com",
                    "maxEdgeBytes": "1522"
                },
                {
                    "hostname": "blog.example.com",
                    "maxEdgeBytes": "3654"
                },
                {
                    "hostname": "img.example.com",
                    "maxEdgeBytes": "4827"
                }
            ]
        },
        {
            "startdatetime": "2022-11-15T14:05:00Z",
            "data": [
                {
                    "hostname": "www.example.com",
                    "maxEdgeBytes": "4160"
                },
                {
                    "hostname": "m.example.com",
                    "maxEdgeBytes": "3262"
                },
                {
                    "hostname": "blog.example.com",
                    "maxEdgeBytes": "1560"
                },
                {
                    "hostname": "img.example.com",
                    "maxEdgeBytes": "2458"
                }
            ]
        },
        {
            "startdatetime": "2022-11-15T14:10:00Z",
            "data": [
                {
                    "hostname": "www.example.com",
                    "maxEdgeBytes": "3570"
                },
                {
                    "hostname": "m.example.com",
                    "maxEdgeBytes": "17"
                },
                {
                    "hostname": "blog.example.com",
                    "maxEdgeBytes": "81"
                },
                {
                    "hostname": "img.example.com",
                    "maxEdgeBytes": "447"
                }
            ]
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,bytes-by-tophostnameandtime
version,1
source,bytes-by-tophostnameandtime/versions/1
groupBy,startdatetime,hostname
start,2022-11-15T13:55:00Z
end,2022-11-15T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
ca,cacheable,non_cacheable
delivery_type,secure,non-secure
hostname_contain,m.example.com,www.example.com
hostname_end_with,m.example.com,www.example.com
hostname_exact_match,blog.example.com,www.example.com
hostname_match,img.example.com,blog.example.com
hostname_not_contain,blog.example.com,img.example.com
hostname_not_end_with,img.example.com,m.example.com
hostname_not_match,blog.example.com,img.example.com
hostname_not_start_with,blog.example.com,m.example.com
hostname_start_with,www.example.com,m.example.com
http_version,http1.1,http2
ip_version,ipv4,ipv6
response_class,1xx,0xx
response_code,201,500
response_status,success,error
traffic,put_post_responses,get_head_responses
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,hostname,maxEdgeBytes
#COLUMNS_END

#DATA_START
2022-11-15T13:55:00Z,www.example.com,482
2022-11-15T13:55:00Z,m.example.com,759
2022-11-15T13:55:00Z,blog.example.com,338
2022-11-15T13:55:00Z,img.example.com,974
2022-11-15T14:00:00Z,www.example.com,4321
2022-11-15T14:00:00Z,m.example.com,1522
2022-11-15T14:00:00Z,blog.example.com,3654
2022-11-15T14:00:00Z,img.example.com,4827
2022-11-15T14:05:00Z,www.example.com,4160
2022-11-15T14:05:00Z,m.example.com,3262
2022-11-15T14:05:00Z,blog.example.com,1560
2022-11-15T14:05:00Z,img.example.com,2458
2022-11-15T14:10:00Z,www.example.com,3570
2022-11-15T14:10:00Z,m.example.com,17
2022-11-15T14:10:00Z,blog.example.com,81
2022-11-15T14:10:00Z,img.example.com,447
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "bytes-by-tophostnameandtime",
    "description": "Edge bytes returned by top hostname and time.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "supportsPagination": false,
    "outputType": "HIERARCHICAL",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "maxEdgeBytes",
            "description": "Maximum edge bytes.",
            "label": "Maximum Edge Bytes",
            "unit": "BYTE",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime",
        "hostname"
    ],
    "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": "hostname_not_contain",
            "type": "string",
            "description": "Hostname does not contain the specified string.",
            "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": "hostname_not_start_with",
            "type": "string",
            "description": "Hostname does not start with the specified string.",
            "required": false
        },
        {
            "name": "hostname_start_with",
            "type": "string",
            "description": "Hostname starts with the specified string.",
            "required": false
        },
        {
            "name": "hostname_match",
            "type": "regexp",
            "description": "Hostname is an exact match for the specified string.",
            "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": "hostname_contain",
            "type": "string",
            "description": "Hostname contains the specified string.",
            "required": false
        },
        {
            "name": "hostname_not_match",
            "type": "regexp",
            "description": "Hostname does not match the specified string.",
            "required": false
        },
        {
            "name": "hostname_not_end_with",
            "type": "string",
            "description": "Hostname does not end with the specified string.",
            "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
        },
        {
            "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": "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": "ip_version",
            "type": "enum",
            "description": " 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
        },
        {
            "name": "hostname_end_with",
            "type": "string",
            "description": "Hostname ends with the specified string.",
            "required": false
        },
        {
            "name": "hostname_exact_match",
            "type": "string",
            "description": "Hostname is an exact match for the specified string.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/bytes-by-tophostnameandtime/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/bytes-by-tophostnameandtime/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/bytes-by-tophostnameandtime/versions/1/report-data"
        }
    ]
}