prefetchedgemetrics-by-time

The following shows how to generate the prefetchedgemetrics-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 volume of responses served by Akamai edge servers when you are using the Akamai Instant (Page Prefetching) behavior. This report only produces daily 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: 30 days

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

Available metrics

MetricDescription
Data metrics
edgeResponsesPerSecondThe rate of all responses from the edge server to the end user.
Summary metrics
edgeResponsesPerSecondLatestThe most recent rate of all responses from the edge server to the end user.
edgeResponsesPerSecondMaxThe highest rate of all responses from the edge server to the end user.
edgeResponsesPerSecondSlopeRepresents the overall change in the number of responses from the edge server to the end user, a positive number if increasing or a negative number if decreasing.
edgeResponsesTotalThe total number of all responses from the edge server to the end user.

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.

POST request

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

Sample: /reporting-api/v1/reports/prefetchedgemetrics-by-time/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40: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-06-26T14: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.
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": [
        "edgeResponsesPerSecond",
        "edgeResponsesPerSecondLatest",
        "edgeResponsesPerSecondMax",
        "edgeResponsesPerSecondSlope",
        "edgeResponsesTotal"
    ],
    "filters": {
        "ca": [
            "cacheable",
            "non_cacheable"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/prefetchedgemetrics-by-time/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=edgeResponsesPerSecond%2CedgeResponsesPerSecondLatest​&filters​=ca%3Dcacheable%2Cca%3Dnon_cacheable

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40: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-06-26T14:00: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.
metricsStringedgeResponsesPerSecond,​edgeResponsesPerSecondLatestSpecifies 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_cacheableSpecifies 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": "prefetchedgemetrics-by-time",
        "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": "ca",
                "values": [
                    "cacheable",
                    "non_cacheable"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "edgeResponsesPerSecond",
                "label": "Edge Responses/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgeResponsesPerSecond": "2473.035837"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgeResponsesPerSecond": "831.463142"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgeResponsesPerSecond": "391.096706"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgeResponsesPerSecond": "2746.593138"
        }
    ],
    "summaryStatistics": {
        "edgeResponsesPerSecondLatest": {
            "value": "156.21697",
            "details": {}
        },
        "edgeResponsesPerSecondMax": {
            "value": "3943.105168",
            "details": {}
        },
        "edgeResponsesPerSecondSlope": {
            "value": "4625",
            "details": {}
        },
        "edgeResponsesTotal": {
            "value": "1372",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​prefetchedgemetrics-by-time
version,​1
source,​prefetchedgemetrics-by-time/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
ca,​cacheable,​non_cacheable
#METADATA_END

#SUMMARYSTATISTICS_START
edgeResponsesPerSecondLatest,​156.21697
edgeResponsesPerSecondMax,​3943.105168
edgeResponsesPerSecondSlope,​4625
edgeResponsesTotal,​1372
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​edgeResponsesPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,2473.035837
2020-06-26T13:45:00Z,831.463142
2020-06-26T13:50:00Z,391.096706
2020-06-26T13:55:00Z,2746.593138
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/prefetchedgemetrics-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "prefetchedgemetrics-by-time",
    "description": "Provides volume of responses served by Akamai edge servers when you are using the Akamai Instant (Page Prefetching) behavior. This report only produces daily data.",
    "businessObjectName": "cpcode",
    "version": 1,
    "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": "edgeResponsesTotal",
            "description": "The total number of all responses from the edge server to the end user.",
            "label": "Total Edge Responses",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeResponsesPerSecond",
            "description": "The rate of all responses from the edge server to the end user.",
            "label": "Edge Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeResponsesPerSecondLatest",
            "description": "The most recent rate of all responses from the edge server to the end user.",
            "label": "Latest Edge Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeResponsesPerSecondMax",
            "description": "The highest rate of all responses from the edge server to the end user.",
            "label": "Peak Edge Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeResponsesPerSecondSlope",
            "description": "Represents the overall change in the number of responses from the edge server to the end user, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Responses/Sec Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "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": 30,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/prefetchedgemetrics-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/prefetchedgemetrics-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/prefetchedgemetrics-by-time/versions/1/report-data"
        }
    ]
}