Reporting API Resources

This section provides details on the Reporting API’s operation and parameters. See Reporting API Workflow for details on how to call the API.

API Summary

Operation Method Endpoint
Reports   (download RAML)
Generate a Report POST /reporting-api/v1/reports/{reportName}/versions/{reportVersion}/report-data{?start,end,interval}

Generate a Report

Produce a report in either JSON or CSV format for a specific version of a type of report. Query parameters specify the range of data and the aggregation interval for each record. Specify a Query request object for a corresponding Report response.

POST /reporting-api/v1/reports/{reportName}/versions/{reportVersion}/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/opresponses-by-time/versions/1/report-data?start=2016–07–01T00%3A00%3A00Z&end=2016–07–02T00%3A00%3A00Z&interval=DAY

Content-Type: application/json

Request Body:

{
    "objectIds": [
        "536194", "536198", "539651", "539798", "539987"
    ],
    "metrics": [
        "top_hits",
        "top_urls",
        "browser_hits",
        "edgres_hits_success",
        "edgres_hits_success_total",
        "edgres_hits_success_min",
        "edgres_hits_success_max",
        "origin_hits_success",
        "origin_hits_success_total",
        "origin_hits_success_min",
        "origin_hits_success_max",
        "midgress_hits_success",
        "midgress_hits_success_total",
        "midgress_hits_success_min",
        "midgress_hits_success_max"
    ],
    "filters": {
        "ip_version": [
            "ipv4"
        ],
        "traffic_type": [
            "standard_secure"
        ]
    },
    "objectType": "cpcode"
}
Parameter Type Sample Description
URL Parameters
reportName String opresponses-by-time Identifies the type of report you want to generate. See Available Reports.
reportVersion Integer 1 The version of the report type. Successive versions may support different sets of metrics and filters.
Required Query Parameters
end String 2016–07–02T00:00:00Z Specifies the end of the reported period as an ISO–8601 UTC time stamp. Any data that matches the end value’s timestamp is excluded from the report.
interval Enumeration DAY The duration of each data record, either FIVE-MINUTE, HOUR, DAY, WEEK, or MONTH. Support for specific interval values may vary by report type.
start String 2016–07–01T00:00:00Z Specifies the start of the reported period as an ISO–8601 UTC time stamp.

Status 200 application/json

Response Body:

{
    "summaryStatistics": {
        "2xxEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allEdgeResponsetimeAvg": {
            "details": {},
            "value": "3297439138"
        },
        "4xxOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allMidgressHitsMin": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "allEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allEdgeHitsMin": {
            "details": {
                "startdatetime": "2016-08-17T23:00:00Z"
            },
            "value": "3297439138"
        },
        "5xxOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allHitsOffloadAvg": {
            "details": {},
            "value": "3297439138"
        },
        "3xxEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allHitsOffloadMax": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "4xxEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "5xxOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allHitsOffloadMin": {
            "details": {
                "startdatetime": "2016-08-17T23:00:00Z"
            },
            "value": "3297439138"
        },
        "5xxEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "3xxOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allMidgressHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "5xxEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "2xxOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "4xxOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allMidgressHitsMax": {
            "details": {
                "startdatetime": "2016-08-19T23:00:00Z"
            },
            "value": "3297439138"
        },
        "allOriginResponsetimeAvg": {
            "details": {},
            "value": "3297439138"
        },
        "3xxEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allEdgeHitsMax": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "2xxOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginHitsMax": {
            "details": {
                "startdatetime": "2016-08-13T23:00:00Z"
            },
            "value": "3297439138"
        },
        "3xxOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginResponsetimeMin": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "otherOriginHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "2xxEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "otherEdgeHitsPercent": {
            "details": {},
            "value": "3297439138"
        },
        "otherEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginHitsMin": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "otherOriginHitsTotal": {
            "details": {},
            "value": "3297439138"
        },
        "allOriginResponsetimeMax": {
            "details": {
                "startdatetime": "2016-08-14T23:00:00Z"
            },
            "value": "3297439138"
        },
        "allEdgeResponsetimeMax": {
            "details": {
                "startdatetime": "2016-08-13T23:00:00Z"
            },
            "value": "3297439138"
        },
        "allEdgeResponsetimeMin": {
            "details": {
                "startdatetime": "2016-08-18T23:00:00Z"
            },
            "value": "3297439138"
        },
        "4xxEdgeHitsTotal": {
            "details": {},
            "value": "3297439138"
        }
    },
    "data": [
        {
            "allHitsOffload": 60,
            "timestamp": "2016-08-17T00:00:00Z",
            "allOriginHitsPerSecond": 850,
            "allMidgressHitsPerSecond": 923,
            "allEdgeHitsPerSecond": 15164
        },
        {
            "allHitsOffload": 63,
            "timestamp": "2016-08-17T01:00:00Z",
            "allOriginHitsPerSecond": 24354,
            "allMidgressHitsPerSecond": 39413,
            "allEdgeHitsPerSecond": 11729
        },
        {
            "allHitsOffload": 66,
            "timestamp": "2016-08-17T02:00:00Z",
            "allOriginHitsPerSecond": 1330,
            "allMidgressHitsPerSecond": 18396,
            "allEdgeHitsPerSecond": 17529
        },
        {
            "allHitsOffload": 60,
            "timestamp": "2016-08-17T03:00:00Z",
            "allOriginHitsPerSecond": 8854,
            "allMidgressHitsPerSecond": 62521,
            "allEdgeHitsPerSecond": 55126
        },
        {
            "allHitsOffload": 78,
            "timestamp": "2016-08-17T04:00:00Z",
            "allOriginHitsPerSecond": 16205,
            "allMidgressHitsPerSecond": 47987,
            "allEdgeHitsPerSecond": 10660
        },
        {
            "allHitsOffload": 23,
            "timestamp": "2016-08-17T05:00:00Z",
            "allOriginHitsPerSecond": 60090,
            "allMidgressHitsPerSecond": 40346,
            "allEdgeHitsPerSecond": 65350
        },
        {
            "allHitsOffload": 51,
            "timestamp": "2016-08-17T06:00:00Z",
            "allOriginHitsPerSecond": 9391,
            "allMidgressHitsPerSecond": 9864,
            "allEdgeHitsPerSecond": 16012
        },
        {
            "allHitsOffload": 97,
            "timestamp": "2016-08-17T07:00:00Z",
            "allOriginHitsPerSecond": 26226,
            "allMidgressHitsPerSecond": 29261,
            "allEdgeHitsPerSecond": 4080
        },
        {
            "allHitsOffload": 81,
            "timestamp": "2016-08-17T08:00:00Z",
            "allOriginHitsPerSecond": 47019,
            "allMidgressHitsPerSecond": 64296,
            "allEdgeHitsPerSecond": 50053
        },
        {
            "allHitsOffload": 84,
            "timestamp": "2016-08-17T09:00:00Z",
            "allOriginHitsPerSecond": 37680,
            "allMidgressHitsPerSecond": 53428,
            "allEdgeHitsPerSecond": 59183
        },
        {
            "allHitsOffload": 97,
            "timestamp": "2016-08-17T10:00:00Z",
            "allOriginHitsPerSecond": 20179,
            "allMidgressHitsPerSecond": 34935,
            "allEdgeHitsPerSecond": 50898
        },
        {
            "allHitsOffload": 24,
            "timestamp": "2016-08-17T11:00:00Z",
            "allOriginHitsPerSecond": 15005,
            "allMidgressHitsPerSecond": 57464,
            "allEdgeHitsPerSecond": 59410
        },
        {
            "allHitsOffload": 88,
            "timestamp": "2016-08-17T12:00:00Z",
            "allOriginHitsPerSecond": 11925,
            "allMidgressHitsPerSecond": 35693,
            "allEdgeHitsPerSecond": 39521
        },
        {
            "allHitsOffload": 93,
            "timestamp": "2016-08-17T13:00:00Z",
            "allOriginHitsPerSecond": 58801,
            "allMidgressHitsPerSecond": 30130,
            "allEdgeHitsPerSecond": 4708
        },
        {
            "allHitsOffload": 77,
            "timestamp": "2016-08-17T14:00:00Z",
            "allOriginHitsPerSecond": 26605,
            "allMidgressHitsPerSecond": 26794,
            "allEdgeHitsPerSecond": 43295
        },
        {
            "allHitsOffload": 94,
            "timestamp": "2016-08-17T15:00:00Z",
            "allOriginHitsPerSecond": 12335,
            "allMidgressHitsPerSecond": 53690,
            "allEdgeHitsPerSecond": 11385
        },
        {
            "allHitsOffload": 34,
            "timestamp": "2016-08-17T16:00:00Z",
            "allOriginHitsPerSecond": 27542,
            "allMidgressHitsPerSecond": 35106,
            "allEdgeHitsPerSecond": 60225
        },
        {
            "allHitsOffload": 25,
            "timestamp": "2016-08-17T17:00:00Z",
            "allOriginHitsPerSecond": 6826,
            "allMidgressHitsPerSecond": 21896,
            "allEdgeHitsPerSecond": 33740
        },
        {
            "allHitsOffload": 79,
            "timestamp": "2016-08-17T18:00:00Z",
            "allOriginHitsPerSecond": 26777,
            "allMidgressHitsPerSecond": 2455,
            "allEdgeHitsPerSecond": 62785
        },
        {
            "allHitsOffload": 98,
            "timestamp": "2016-08-17T19:00:00Z",
            "allOriginHitsPerSecond": 54397,
            "allMidgressHitsPerSecond": 5057,
            "allEdgeHitsPerSecond": 2353
        },
        {
            "allHitsOffload": 84,
            "timestamp": "2016-08-17T20:00:00Z",
            "allOriginHitsPerSecond": 56380,
            "allMidgressHitsPerSecond": 11059,
            "allEdgeHitsPerSecond": 41339
        },
        {
            "allHitsOffload": 79,
            "timestamp": "2016-08-17T21:00:00Z",
            "allOriginHitsPerSecond": 31328,
            "allMidgressHitsPerSecond": 4823,
            "allEdgeHitsPerSecond": 38348
        },
        {
            "allHitsOffload": 12,
            "timestamp": "2016-08-17T22:00:00Z",
            "allOriginHitsPerSecond": 45209,
            "allMidgressHitsPerSecond": 47543,
            "allEdgeHitsPerSecond": 41124
        },
        {
            "allHitsOffload": 67,
            "timestamp": "2016-08-17T23:00:00Z",
            "allOriginHitsPerSecond": 29066,
            "allMidgressHitsPerSecond": 63968,
            "allEdgeHitsPerSecond": 62975
        }
    ],
    "metadata": {
        "end": "2016-08-18T00:00:00Z",
        "name": "report-name",
        "start": "2016-08-17T00:00:00Z",
        "interval": "HOUR",
        "uri": "/reporting-report-executor/reports/traffic-by-time/v1",
        "objectIds": [
        "536194", "536198", "539651", "539798", "539987"
    ],
        "rowCount": 24,
        "version": "1",
        "filters": [
            {
                "name": "ip_version",
                "value": [
                    "ipv4"
                ]
            }
        ],
        "groupBy": [
            "timestamp"
        ],
        "columns": [
            {
                "name": "allEdgeHitsPerSecond",
                "label": "Column description of allEdgeHitsPerSecond for ui"
            },
            {
                "name": "allOriginHitsPerSecond",
                "label": "Column description of allOriginHitsPerSecond for ui"
            },
            {
                "name": "allMidgressHitsPerSecond",
                "label": "Column description of allMidgressHitsPerSecond for ui"
            },
            {
                "name": "allHitsOffload",
                "label": "Column description of allHitsOffload for ui"
            },
            {
                "name": "allHitsOffloadAvg",
                "label": "Column description of allHitsOffloadAvg for ui"
            },
            {
                "name": "allHitsOffloadMin",
                "label": "Column description of allHitsOffloadMin for ui"
            },
            {
                "name": "allHitsOffloadMax",
                "label": "Column description of allHitsOffloadMax for ui"
            },
            {
                "name": "allEdgeHitsTotal",
                "label": "Column description of allEdgeHitsTotal for ui"
            },
            {
                "name": "allEdgeHitsMin",
                "label": "Column description of allEdgeHitsMin for ui"
            },
            {
                "name": "allEdgeHitsMax",
                "label": "Column description of allEdgeHitsMax for ui"
            },
            {
                "name": "allMidgressHitsTotal",
                "label": "Column description of allMidgressHitsTotal for ui"
            },
            {
                "name": "allMidgressHitsMin",
                "label": "Column description of allMidgressHitsMin for ui"
            },
            {
                "name": "allMidgressHitsMax",
                "label": "Column description of allMidgressHitsMax for ui"
            },
            {
                "name": "allOriginHitsTotal",
                "label": "Column description of allOriginHitsTotal for ui"
            },
            {
                "name": "allOriginHitsMin",
                "label": "Column description of allOriginHitsMin for ui"
            },
            {
                "name": "allOriginHitsMax",
                "label": "Column description of allOriginHitsMax for ui"
            },
            {
                "name": "allEdgeResponsetimeAvg",
                "label": "Column description of allEdgeResponsetimeAvg for ui"
            },
            {
                "name": "allEdgeResponsetimeMin",
                "label": "Column description of allEdgeResponsetimeMin for ui"
            },
            {
                "name": "allEdgeResponsetimeMax",
                "label": "Column description of allEdgeResponsetimeMax for ui"
            },
            {
                "name": "allOriginResponsetimeAvg",
                "label": "Column description of allOriginResponsetimeAvg for ui"
            },
            {
                "name": "allOriginResponsetimeMin",
                "label": "Column description of allOriginResponsetimeMin for ui"
            },
            {
                "name": "allOriginResponsetimeMax",
                "label": "Column description of allOriginResponsetimeMax for ui"
            },
            {
                "name": "allEdgeHitsPercent",
                "label": "Column description of allEdgeHitsPercent for ui"
            },
            {
                "name": "2xxEdgeHitsTotal",
                "label": "Column description of 2xxEdgeHitsTotal for ui"
            },
            {
                "name": "2xxEdgeHitsPercent",
                "label": "Column description of 2xxEdgeHitsPercent for ui"
            },
            {
                "name": "3xxEdgeHitsTotal",
                "label": "Column description of 3xxEdgeHitsTotal for ui"
            },
            {
                "name": "3xxEdgeHitsPercent",
                "label": "Column description of 3xxEdgeHitsPercent for ui"
            },
            {
                "name": "4xxEdgeHitsTotal",
                "label": "Column description of 4xxEdgeHitsTotal for ui"
            },
            {
                "name": "4xxEdgeHitsPercent",
                "label": "Column description of 4xxEdgeHitsPercent for ui"
            },
            {
                "name": "5xxEdgeHitsTotal",
                "label": "Column description of 5xxEdgeHitsTotal for ui"
            },
            {
                "name": "5xxEdgeHitsPercent",
                "label": "Column description of 5xxEdgeHitsPercent for ui"
            },
            {
                "name": "otherEdgeHitsTotal",
                "label": "Column description of otherEdgeHitsTotal for ui"
            },
            {
                "name": "otherEdgeHitsPercent",
                "label": "Column description of otherEdgeHitsPercent for ui"
            },
            {
                "name": "allOriginHitsPercent",
                "label": "Column description of allOriginHitsPercent for ui"
            },
            {
                "name": "2xxOriginHitsTotal",
                "label": "Column description of 2xxOriginHitsTotal for ui"
            },
            {
                "name": "2xxOriginHitsPercent",
                "label": "Column description of 2xxOriginHitsPercent for ui"
            },
            {
                "name": "3xxOriginHitsTotal",
                "label": "Column description of 3xxOriginHitsTotal for ui"
            },
            {
                "name": "3xxOriginHitsPercent",
                "label": "Column description of 3xxOriginHitsPercent for ui"
            },
            {
                "name": "4xxOriginHitsTotal",
                "label": "Column description of 4xxOriginHitsTotal for ui"
            },
            {
                "name": "4xxOriginHitsPercent",
                "label": "Column description of 4xxOriginHitsPercent for ui"
            },
            {
                "name": "5xxOriginHitsTotal",
                "label": "Column description of 5xxOriginHitsTotal for ui"
            },
            {
                "name": "5xxOriginHitsPercent",
                "label": "Column description of 5xxOriginHitsPercent for ui"
            },
            {
                "name": "otherOriginHitsTotal",
                "label": "Column description of otherOriginHitsTotal for ui"
            },
            {
                "name": "otherOriginHitsPercent",
                "label": "Column description of otherOriginHitsPercent for ui"
            }
        ],
        "objectType": "cpcode"
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,some_category
version,1
source,some_category/versions/1
groupBy,service,url
start,2017-01-01T00:00:00Z
end,2017-01-01T00:15:00Z
interval,FIVE_MINUTES,
availableDataEnds,
suggestedRetryTime,
rowCount,2
objectType,cpcode
objectIds,113453,313508
http_method,include_putpost
ip_version,ipv4
#METADATA_END

#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END

#COLUMNS_START
service,url,metric1,metric2
#COLUMNS_END

#DATA_START
ts.download.akamai.com,/../login.php,11,21
ts.download.akamai.com,/:443,12,22
#DATA_END

Available Reports

The following details each type of report the Reporting API generates. Each reportName appears along with its most recent reportVersion. The accompanying objectType describes the type of value you may specify as a set of objectIds in the POST request. See also the metrics and filters available for these categories.

reportName reportVersion objectType Description
aic-by-time 2 cpcode Provides the number of images compressed per second to improve performance, based on network conditions.
cmlogline-by-time 1 cpcode Provides real-time logging data for your HTTP traffic.
cmreq-by-cpcode 1 cpcode Provides HTTP transaction data delivered through the edge platform to your end users at the CP code level.
cmreq-by-time 1 cpcode Provides HTTP transaction data delivered through the edge platform to your end users.
icbytes-by-url 1 cpcode Provides URL volume data associated with supported image formats: JPG, GIF, and PNG configured for Image Converter. Since this report only produces daily data, the only valid interval value is DAY.
ichits-by-url 1 cpcode Provides URL traffic data associated with supported image formats: JPG, GIF, and PNG configured for Image Converter. Since this report only produces daily data, the only valid interval value is DAY.
ictraffic-by-time 1 cpcode Provides data about traffic and bandwidth associated with supported image formats configured for Image Converter.
imbytes-by-browser 1 cpcode Provides volume data for images configured to use Image Manager at the browser level.
imbytes-by-imagetype 1 cpcode Provides volume data for images configured to use Image Manager at the image type level.
imbytes-by-policy 1 cpcode Provides volume data for images configured to use Image Manager at the token policy level.
imbytes-by-policyandbrowser 1 cpcode Provides volume data for images configured to use Image Manager at the token policy and browser level.
imbytes-by-policyandimagetype 1 cpcode Provides volume data for images configured to use Image Manager at the token policy and image type level.
imbytes-by-policyandwidth 1 cpcode Provides volume data for images configured to use Image Manager at the token policy and image width level.
imbytes-by-width 1 cpcode Provides volume data for images configured to use Image Manager at the image width level.
imhits-by-browser 1 cpcode Provides hits data for images configured to use Image Manager at the browser level.
imhits-by-imagetype 1 cpcode Provides traffic data for images configured to use Image Manager on your site.
imhits-by-policy 1 cpcode Provides hits data for images configured to use Image Manager at the token policy level.
imhits-by-policyandbrowser 1 cpcode Provides hits data for images configured to use Image Manager at the token policy and browser level.
imhits-by-policyandimagetype 1 cpcode Provides hits data for images configured to use Image Manager at the token policy and image type level.
imhits-by-policyandwidth 1 cpcode Provides hits data for images configured to use Image Manager at the token policy and image width level.
imhits-by-width 1 cpcode Provides hits data for images configured to use Image Manager at the image width level.
imtopbytesurls-by-url 1 cpcode Provides URL volume data for images configured to use Image Manager, by URL.
imtophiturls-by-url 1 cpcode Provides URL traffic data for images configured to use Image Manager, by URL.
imtraffic-by-time 1 cpcode Provides traffic data for images configured to use Image Manager at the image type level.
opresponses-by-time 2 cpcode Provides performance data for Akamai edge servers requests to your origin servers.
prefetchedgemetrics-by-time 1 cpcode Provides volume of responses served by Akamai edge servers when you are using the Akamai Instant (Page Prefetching) behavior. Since this report only produces daily data, the only valid interval value is DAY.
prefetchedgepfmetrics-by-time 1 cpcode 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. Since this report only produces daily data, the only valid interval value is DAY.
prefetchoriginmetrics-by-time 1 cpcode Provides volume of responses served by your origin server when you are using the Akamai Instant (Page Prefetching) behavior. Since this report only produces daily data, the only valid interval value is DAY.
saastraffic-by-app 1 cpcode Provides traffic data at a SaaS application level. Since this report only produces daily data, the only valid interval value is DAY.
saastraffic-by-cust 1 cpcode Provides traffic data at a SaaS customer level. Since this report only produces daily data, the only valid interval value is DAY.
snistats-by-host 1 cpcode Provides SNI capability data for SSL connections at the hostname level.
snistats-by-hostappcustsaas 1 cpcode Provides SNI capability data for SSL connections at the hostname, SaaS customer, and SaaS application level.
upsrtraffic-by-time 1 cpcode Provides the percentage of traffic for which SureRoute provided a faster route for responses. Since this report only produces daily data, the only valid interval value is DAY.

Last modified: 10/23/2017