opresponses-by-time

The following shows how to generate the opresponses-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 performance data for Akamai edge servers requests to your origin servers.

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

Required products: Ion OTA Updates, Dynamic Site Accelerator, or Dynamic Site Delivery

Available metrics

MetricDescription
Data metrics
avgResponseTimeThe average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.
maxOriginResponseTimeThe highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.
minOriginResponseTimeThe lowest elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.
originResponsesThe number of responses from your origin to edge servers.
Summary metrics
avgResponseTimeMaxThe highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.
avgResponseTimeSlopeRepresents the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.
maxOriginResponseTimeMaxThe highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.
maxOriginResponseTimeSlopeRepresents the highest point of the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.
minOriginResponseTimeMaxThe lowest elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.
minOriginResponseTimeSlopeRepresents the lowest point of the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.
originResponsesMaxThe highest number of responses from your origin to edge servers.
originResponsesSlopeRepresents the overall change in the number of responses over time, a positive number if increasing or a negative number if decreasing.
originResponsesTotalThe total number of all responses served from the origin.

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.
response_codeIntegerAn HTTP response status code, for example, 201.

POST request

POST /reporting-api/v1/reports/opresponses-by-time/versions/2/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/opresponses-by-time/versions/2/report-data?start​=2020-08-26T13%3A55%3A00Z​&end​=2020-08-26T14%3A15%3A00Z​&interval​=FIVE_MINUTES

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

Sample with longer interval: /reporting-api/v1/reports/opresponses-by-time/versions/2/report-data?start=2020-04-01&end=2020-08-01&interval=MONTH

Query parameters

ParameterTypeSampleDescription
Required
startString2020-08-26T13: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.
endString2020-08-26T14: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": [
        "avgResponseTime",
        "avgResponseTimeMax",
        "avgResponseTimeSlope",
        "maxOriginResponseTime",
        "maxOriginResponseTimeMax",
        "maxOriginResponseTimeSlope",
        "minOriginResponseTime",
        "minOriginResponseTimeMax",
        "minOriginResponseTimeSlope",
        "originResponses",
        "originResponsesMax",
        "originResponsesSlope",
        "originResponsesTotal"
    ],
    "filters": {
        "ca": [
            "cacheable",
            "non_cacheable"
        ],
        "response_code": [
            "200",
            "503"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/opresponses-by-time/versions/2/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/opresponses-by-time/versions/2/report-data?start​=2020-08-26T13%3A55%3A00Z​&end​=2020-08-26T14%3A15%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=avgResponseTime%2CavgResponseTimeMax​&filters​=ca%3Dcacheable%2Cca%3Dnon_cacheable%2Cresponse_code%3D500%2Cresponse_code%3D200

Query parameters

ParameterTypeSampleDescription
Required
startString2020-08-26T13:55: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.
endString2020-08-26T14:15:00ZSpecifies if unavailable reports should be shown.
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.
metricsStringavgResponseTime,​avgResponseTimeMaxSpecifies 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,​response_code=​500,​response_code=​200Specifies 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": "opresponses-by-time",
        "version": "2",
        "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": "ca",
                "values": [
                    "cacheable",
                    "non_cacheable"
                ]
            },
            {
                "name": "response_code",
                "values": [
                    "500",
                    "200"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "avgResponseTime",
                "label": "Average Origin Response Time "
            },
            {
                "name": "maxOriginResponseTime",
                "label": "Maximum Origin Response Time "
            },
            {
                "name": "minOriginResponseTime",
                "label": "Minimum Origin Response Time"
            },
            {
                "name": "originResponses",
                "label": "Origin Responses/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-08-26T13:55:00Z",
            "avgResponseTime": "558",
            "maxOriginResponseTime": "1173",
            "minOriginResponseTime": "706",
            "originResponses": "4490.429406"
        },
        {
            "startdatetime": "2020-08-26T14:00:00Z",
            "avgResponseTime": "1016",
            "maxOriginResponseTime": "248",
            "minOriginResponseTime": "455",
            "originResponses": "412.982016"
        },
        {
            "startdatetime": "2020-08-26T14:05:00Z",
            "avgResponseTime": "1144",
            "maxOriginResponseTime": "905",
            "minOriginResponseTime": "773",
            "originResponses": "1137.77327"
        },
        {
            "startdatetime": "2020-08-26T14:10:00Z",
            "avgResponseTime": "320",
            "maxOriginResponseTime": "1119",
            "minOriginResponseTime": "194",
            "originResponses": "3941.146076"
        }
    ],
    "summaryStatistics": {
        "avgResponseTimeMax": {
            "value": "891",
            "details": {}
        },
        "avgResponseTimeSlope": {
            "value": "3090",
            "details": {}
        },
        "maxOriginResponseTimeMax": {
            "value": "421",
            "details": {}
        },
        "maxOriginResponseTimeSlope": {
            "value": "2015",
            "details": {}
        },
        "minOriginResponseTimeMax": {
            "value": "1116",
            "details": {}
        },
        "minOriginResponseTimeSlope": {
            "value": "521",
            "details": {}
        },
        "originResponsesMax": {
            "value": "3220.28298",
            "details": {}
        },
        "originResponsesSlope": {
            "value": "2509",
            "details": {}
        },
        "originResponsesTotal": {
            "value": "2606",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​opresponses-by-time
version,​2
source,​opresponses-by-time/versions/2
groupBy,​startdatetime
start,​2020-08-26T13:55:00Z
end,​2020-08-26T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
ca,​cacheable,​non_cacheable
response_code,​500,​200
#METADATA_END

#SUMMARYSTATISTICS_START
avgResponseTimeMax,​891
avgResponseTimeSlope,​3090
maxOriginResponseTimeMax,​421
maxOriginResponseTimeSlope,​2015
minOriginResponseTimeMax,​1116
minOriginResponseTimeSlope,​521
originResponsesMax,​3220.28298
originResponsesSlope,​2509
originResponsesTotal,​2606
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​avgResponseTime,​maxOriginResponseTime,​minOriginResponseTime,​originResponses
#COLUMNS_END

#DATA_START
2020-08-26T13:55:00Z,558,​1173,​706,​4490.429406
2020-08-26T14:00:00Z,1016,​248,​455,​412.982016
2020-08-26T14:05:00Z,1144,​905,​773,​1137.77327
2020-08-26T14:10:00Z,320,​1119,​194,​3941.146076
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/opresponses-by-time/versions/2

Status 200 application/json

Response body:

{
    "name": "opresponses-by-time",
    "description": "Provides performance data for Akamai edge servers requests to your origin servers.",
    "businessObjectName": "cpcode",
    "version": 2,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Ion OTA Updates",
        "Dynamic Site Accelerator",
        "Dynamic Site Delivery"
    ],
    "requiredRoles": [
        "Widget Reports - View Only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "avgResponseTimeMax",
            "description": "The highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.",
            "label": "Average Origin Response Time Peak",
            "unit": "MILLISECOND",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesTotal",
            "description": "The total number of all responses served from the origin.",
            "label": "Origin Responses Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "minOriginResponseTime",
            "description": "The lowest elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.",
            "label": "Minimum Origin Response Time",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "minOriginResponseTimeMax",
            "description": "The lowest elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.",
            "label": "Minimum Origin Response Time Peak",
            "unit": "MILLISECOND",
            "summaryStatistic": true
        },
        {
            "name": "maxOriginResponseTime",
            "description": "The highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.",
            "label": "Maximum Origin Response Time ",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "avgResponseTime",
            "description": "The average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range.",
            "label": "Average Origin Response Time ",
            "unit": "MILLISECOND",
            "summaryStatistic": false
        },
        {
            "name": "maxOriginResponseTimeMax",
            "description": "The highest elapsed time in milliseconds for request/response exchanges from your origin to edge servers.",
            "label": "Maximum Origin Response Time Peak",
            "unit": "MILLISECOND",
            "summaryStatistic": true
        },
        {
            "name": "originResponses",
            "description": "The number of responses from your origin to edge servers.",
            "label": "Origin Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originResponsesMax",
            "description": "The highest number of responses from your origin to edge servers.",
            "label": "Origin Responses/Sec Peak",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "avgResponseTimeSlope",
            "description": "Represents the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.",
            "label": "Average Origin Response Time Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "maxOriginResponseTimeSlope",
            "description": "Represents the highest point of the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.",
            "label": "Maximum Origin Response Time Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "minOriginResponseTimeSlope",
            "description": "Represents the lowest point of the overall change in the average elapsed time in milliseconds for request/response exchanges from your origin to edge servers for the selected date range. A positive number if increasing or a negative number if decreasing.",
            "label": "Minimum Origin Response Time Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesSlope",
            "description": "Represents the overall change in the number of responses over time, a positive number if increasing or a negative number if decreasing.",
            "label": "Origin Responses/Sec Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "response_code",
            "type": "int",
            "description": "An HTTP response status code, for example, 201.",
            "required": false
        },
        {
            "name": "ca",
            "type": "enum",
            "description": "Indicates whether content is storable.",
            "values": [
                {
                    "value": "non_cacheable",
                    "description": "Can't be stored (identified as 'no-store' or has a 0 TTL) and will always trigger an origin request."
                },
                {
                    "value": "cacheable",
                    "description": "Can be stored after an initial request for faster future delivery."
                }
            ],
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/opresponses-by-time/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/opresponses-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/opresponses-by-time/versions/2/report-data"
        }
    ]
}