prefetchoriginmetrics-by-time

The following shows how to generate the prefetchoriginmetrics-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 your origin server 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
originPrefetchResponsesPerSecondThe rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.
originResponsesPerSecondThe rate of all responses served from the origin.
Summary metrics
originPrefetchResponsesPerSecondLatestThe most recent rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.
originPrefetchResponsesPerSecondMaxThe highest rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.
originPrefetchResponsesPerSecondSlopeRepresents the overall change in number of all of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages, a positive number if increasing or a negative number if decreasing.
originPrefetchResponsesTotalThe total number of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.
originResponsesPerSecondLatestThe most recent rate of all responses served from the origin.
originResponsesPerSecondMaxThe highest rate of all responses served from the origin.
originResponsesPerSecondSlopeRepresents the overall change in number of all responses served from the origin, 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.

POST request

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

Sample: /reporting-api/v1/reports/prefetchoriginmetrics-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": [
        "originPrefetchResponsesPerSecond",
        "originPrefetchResponsesPerSecondLatest",
        "originPrefetchResponsesPerSecondMax",
        "originPrefetchResponsesPerSecondSlope",
        "originPrefetchResponsesTotal",
        "originResponsesPerSecond",
        "originResponsesPerSecondLatest",
        "originResponsesPerSecondMax",
        "originResponsesPerSecondSlope",
        "originResponsesTotal"
    ],
    "filters": {
        "ca": [
            "cacheable",
            "non_cacheable"
        ]
    }
}

GET request

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

Sample: /reporting-api/v1/reports/prefetchoriginmetrics-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​=originPrefetchResponsesPerSecond%2CoriginPrefetchResponsesPerSecondLatest​&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.
metricsStringoriginPrefetchResponsesPerSecond,​originPrefetchResponsesPerSecondLatestSpecifies 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": "prefetchoriginmetrics-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": "originPrefetchResponsesPerSecond",
                "label": "Origin Prefetch Responses/Sec"
            },
            {
                "name": "originResponsesPerSecond",
                "label": "Origin Responses/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "originPrefetchResponsesPerSecond": "4658.907347",
            "originResponsesPerSecond": "4826.158243"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "originPrefetchResponsesPerSecond": "2347.908914",
            "originResponsesPerSecond": "1190.911757"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "originPrefetchResponsesPerSecond": "1071.720908",
            "originResponsesPerSecond": "4714.727803"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "originPrefetchResponsesPerSecond": "464.727036",
            "originResponsesPerSecond": "3456.339773"
        }
    ],
    "summaryStatistics": {
        "originPrefetchResponsesPerSecondLatest": {
            "value": "4806.174715",
            "details": {}
        },
        "originPrefetchResponsesPerSecondMax": {
            "value": "640.600827",
            "details": {}
        },
        "originPrefetchResponsesPerSecondSlope": {
            "value": "4367",
            "details": {}
        },
        "originPrefetchResponsesTotal": {
            "value": "3171",
            "details": {}
        },
        "originResponsesPerSecondLatest": {
            "value": "2239.701634",
            "details": {}
        },
        "originResponsesPerSecondMax": {
            "value": "299.485744",
            "details": {}
        },
        "originResponsesPerSecondSlope": {
            "value": "3616",
            "details": {}
        },
        "originResponsesTotal": {
            "value": "4253",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​prefetchoriginmetrics-by-time
version,​1
source,​prefetchoriginmetrics-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
originPrefetchResponsesPerSecondLatest,​4806.174715
originPrefetchResponsesPerSecondMax,​640.600827
originPrefetchResponsesPerSecondSlope,​4367
originPrefetchResponsesTotal,​3171
originResponsesPerSecondLatest,​2239.701634
originResponsesPerSecondMax,​299.485744
originResponsesPerSecondSlope,​3616
originResponsesTotal,​4253
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​originPrefetchResponsesPerSecond,​originResponsesPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,4658.907347,​4826.158243
2020-06-26T13:45:00Z,2347.908914,​1190.911757
2020-06-26T13:50:00Z,1071.720908,​4714.727803
2020-06-26T13:55:00Z,464.727036,​3456.339773
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "prefetchoriginmetrics-by-time",
    "description": "Provides volume of responses served by your origin server 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": "originPrefetchResponsesTotal",
            "description": "The total number of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.",
            "label": "Total Origin Prefetch Responses",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesTotal",
            "description": "The total number of all responses served from the origin.",
            "label": "Total Origin Responses",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesPerSecondMax",
            "description": "The highest rate of all responses served from the origin.",
            "label": "Peak Origin Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originPrefetchResponsesPerSecond",
            "description": "The rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.",
            "label": "Origin Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originResponsesPerSecond",
            "description": "The rate of all responses served from the origin.",
            "label": "Origin Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originPrefetchResponsesPerSecondLatest",
            "description": "The most recent rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.",
            "label": "Latest Origin Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originPrefetchResponsesPerSecondMax",
            "description": "The highest rate of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages.",
            "label": "Peak Origin Prefetch Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesPerSecondLatest",
            "description": "The most recent rate of all responses served from the origin.",
            "label": "Latest Origin Responses/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originResponsesPerSecondSlope",
            "description": "Represents the overall change in number of all responses served from the origin, a positive number if increasing or a negative number if decreasing.",
            "label": "Peak Origin Responses/Sec Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "originPrefetchResponsesPerSecondSlope",
            "description": "Represents the overall change in number of all of responses served from the origin for prefetch requests, which includes embedded objects as well as Akamai Instant requests for prefetched pages, a positive number if increasing or a negative number if decreasing.",
            "label": "Peak Origin 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/prefetchoriginmetrics-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/prefetchoriginmetrics-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/prefetchoriginmetrics-by-time/versions/1/report-data"
        }
    ]
}