🚧

The prefetchedgepfmetrics-by-time report is being discontinued

This report is deprecated and will be deactivated on May 14, 2025.

The following shows how to generate the prefetchedgepfmetrics-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 cache hits served by Akamai edge servers for no-store or low-TTL objects 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

Available filters

POST request

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

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

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgePrefetchResponsesPerSecond",
        "edgePrefetchResponsesPerSecondLatest",
        "edgePrefetchResponsesPerSecondMax",
        "edgePrefetchResponsesPerSecondSlope",
        "edgePrefetchResponsesTotal"
    ],
    "filters": {
        "ca": [
            "cacheable",
            "non_cacheable"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/prefetchedgepfmetrics-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​=edgePrefetchResponsesPerSecond%2CedgePrefetchResponsesPerSecondLatest​&filters​=ca%3Dcacheable%2Cca%3Dnon_cacheable

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "prefetchedgepfmetrics-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": "edgePrefetchResponsesPerSecond",
                "label": "Edge Prefetch Responses/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgePrefetchResponsesPerSecond": "137.489346"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgePrefetchResponsesPerSecond": "528.14284"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgePrefetchResponsesPerSecond": "4962.558681"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgePrefetchResponsesPerSecond": "4232.590231"
        }
    ],
    "summaryStatistics": {
        "edgePrefetchResponsesPerSecondLatest": {
            "value": "3340.181815",
            "details": {}
        },
        "edgePrefetchResponsesPerSecondMax": {
            "value": "458.323516",
            "details": {}
        },
        "edgePrefetchResponsesPerSecondSlope": {
            "value": "2272",
            "details": {}
        },
        "edgePrefetchResponsesTotal": {
            "value": "596",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​prefetchedgepfmetrics-by-time
version,​1
source,​prefetchedgepfmetrics-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
edgePrefetchResponsesPerSecondLatest,​3340.181815
edgePrefetchResponsesPerSecondMax,​458.323516
edgePrefetchResponsesPerSecondSlope,​2272
edgePrefetchResponsesTotal,​596
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​edgePrefetchResponsesPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,137.489346
2020-06-26T13:45:00Z,528.14284
2020-06-26T13:50:00Z,4962.558681
2020-06-26T13:55:00Z,4232.590231
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "prefetchedgepfmetrics-by-time",
    "description": "Provides volume of cache hits served by Akamai edge servers for no-store or low-TTL objects when you are using the Akamai Instant (Page Prefetching) behavior. This report only produces daily data.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "DEPRECATED",
    "deprecated": true,
    "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": "edgePrefetchResponsesPerSecondMax",
            "description": "The highest rate of edge cache hits for request messages correlated to no-store or low TTL objects. Note that this value can be zero when it is related to no-store content.",
            "label": "Peak Edge Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgePrefetchResponsesPerSecond",
            "description": "The rate of edge cache hits for request messages correlated to no-store or low TTL objects. Note that this value can be zero when it is related to no-store content.",
            "label": "Edge Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgePrefetchResponsesPerSecondLatest",
            "description": "The most recent rate of edge cache hits for request messages correlated to no-store or low TTL objects. Note that this value can be zero when it is related to no-store content.",
            "label": "Latest Edge Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgePrefetchResponsesTotal",
            "description": "The total number of edge cache hits for request messages correlated to no-store or low TTL objects. Note that this value can be zero when it is related to no-store content.",
            "label": "Total Edge Prefetch Responses",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgePrefetchResponsesPerSecondSlope",
            "description": "Represents the overall change in the number of edge cache hits for request messages correlated to no-store or low TTL objects, a positive number if increasing or a negative number if decreasing.",
            "label": "Edge Prefetch 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/prefetchedgepfmetrics-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/prefetchedgepfmetrics-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/prefetchedgepfmetrics-by-time/versions/1/report-data"
        }
    ]
}