Akamai APIs API Documentation
Generate a report
POST https://{{host}}/reporting-api/v1/reports/:name/versions/:version/report-data?start={{start}}&end={{end}}&interval={{interval}}
Produce a report in either JSON or CSV format for a specific version of a type of report. In CSV data, values with commas or space characters are quoted. Query parameters specify the range of data and the aggregation interval for each record.
Body
PARAM
| Key | Datatype | Required | Description |
start
|
string | (Required) Specifies the start of the reported period as an ISO 8601 date with timezone. | |
end
|
string | (Required) Specifies the end of the reported period as an ISO 8601 date with timezone. Any data that matches the `end` value's timestamp is excluded from the report. | |
interval
|
string | (Required) __Enum__ The duration of each data record, either `FIVE_MINUTES`, `HOUR`, `DAY`, `WEEK`, or `MONTH`. Support for specific interval values may vary by report type. | |
dataWrapNumberOfItems
|
string | (Optional) For reports that allow non-top values to cluster, this specifies the number of top values to report on separately. | |
dataWrapLabel
|
string | (Optional) Label used as title for grouped record. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"data": [
{
"edgeHitsPerSecond": "11638.79055555556",
"hitsOffload": "99.80207947341608",
"originHitsPerSecond": "23.03555555555556",
"startdatetime": "2022-09-27T00:00:00Z"
},
{
"edgeHitsPerSecond": "11528.85722222222",
"hitsOffload": "99.80730238127582",
"originHitsPerSecond": "22.21583333333333",
"startdatetime": "2022-09-27T01:00:00Z"
},
{
"edgeHitsPerSecond": "10813.27194444444",
"hitsOffload": "99.77512459675647",
"originHitsPerSecond": "24.31638888888889",
"startdatetime": "2022-09-27T02:00:00Z"
},
{
"edgeHitsPerSecond": "10115.34694444444",
"hitsOffload": "99.79656050134382",
"originHitsPerSecond": "20.57861111111111",
"startdatetime": "2022-09-27T03:00:00Z"
},
{
"edgeHitsPerSecond": "8982.198055555556",
"hitsOffload": "99.79820579057100",
"originHitsPerSecond": "18.12555555555556",
"startdatetime": "2022-09-27T04:00:00Z"
},
{
"edgeHitsPerSecond": "8748.658611111111",
"hitsOffload": "99.81821022657727",
"originHitsPerSecond": "15.90416666666667",
"startdatetime": "2022-09-27T05:00:00Z"
},
{
"edgeHitsPerSecond": "9083.933055555556",
"hitsOffload": "99.79853623731693",
"originHitsPerSecond": "18.30083333333333",
"startdatetime": "2022-09-27T06:00:00Z"
},
{
"edgeHitsPerSecond": "9410.549722222222",
"hitsOffload": "99.80943078098018",
"originHitsPerSecond": "17.93361111111111",
"startdatetime": "2022-09-27T07:00:00Z"
},
{
"edgeHitsPerSecond": "9655.309166666667",
"hitsOffload": "99.80189943281924",
"originHitsPerSecond": "19.12722222222222",
"startdatetime": "2022-09-27T08:00:00Z"
},
{
"edgeHitsPerSecond": "10095.22222222222",
"hitsOffload": "99.80545252429642",
"originHitsPerSecond": "19.64",
"startdatetime": "2022-09-27T09:00:00Z"
},
{
"edgeHitsPerSecond": "11075.87222222222",
"hitsOffload": "99.82769353003049",
"originHitsPerSecond": "19.08444444444444",
"startdatetime": "2022-09-27T10:00:00Z"
},
{
"edgeHitsPerSecond": "13070.17583333333",
"hitsOffload": "99.86389284527393",
"originHitsPerSecond": "17.78944444444444",
"startdatetime": "2022-09-27T11:00:00Z"
},
{
"edgeHitsPerSecond": "14777.06972222222",
"hitsOffload": "99.87547335679674",
"originHitsPerSecond": "18.40138888888889",
"startdatetime": "2022-09-27T12:00:00Z"
},
{
"edgeHitsPerSecond": "15994.95472222222",
"hitsOffload": "99.88541873021522",
"originHitsPerSecond": "18.32722222222222",
"startdatetime": "2022-09-27T13:00:00Z"
},
{
"edgeHitsPerSecond": "16352.24194444444",
"hitsOffload": "99.88731582524591",
"originHitsPerSecond": "18.42638888888889",
"startdatetime": "2022-09-27T14:00:00Z"
},
{
"edgeHitsPerSecond": "16292.22222222222",
"hitsOffload": "99.88244390643115",
"originHitsPerSecond": "19.1525",
"startdatetime": "2022-09-27T15:00:00Z"
},
{
"edgeHitsPerSecond": "15759.10888888889",
"hitsOffload": "99.88705473899469",
"originHitsPerSecond": "17.79916666666667",
"startdatetime": "2022-09-27T16:00:00Z"
},
{
"edgeHitsPerSecond": "15293.54583333333",
"hitsOffload": "99.88316785412292",
"originHitsPerSecond": "17.86777777777778",
"startdatetime": "2022-09-27T17:00:00Z"
},
{
"edgeHitsPerSecond": "15228.42194444444",
"hitsOffload": "99.85940215334561",
"originHitsPerSecond": "21.41083333333333",
"startdatetime": "2022-09-27T18:00:00Z"
}
],
"metadata": {
"availableDataEnds": "2022-09-27T19:00:00Z",
"columns": [
{
"label": "startdatetime",
"name": "groupBy"
},
{
"label": "Edge Hits/Sec",
"name": "edgeHitsPerSecond"
},
{
"label": "Offloaded Hits",
"name": "hitsOffload"
},
{
"label": "Origin Hits/Sec",
"name": "originHitsPerSecond"
}
],
"end": "2022-09-28T00:00:00Z",
"filters": [
{
"name": "delivery_type",
"values": [
"secure"
]
}
],
"groupBy": [
"startdatetime"
],
"interval": "HOUR",
"name": "hits-by-time",
"objectIds": [
"16399"
],
"objectType": "cpcode",
"outputType": "FLAT",
"rowCount": 24,
"start": "2022-09-27T00:00:00Z",
"suggestedRetryTime": "2022-09-28T11:54:08.901648Z",
"version": "1"
},
"summaryStatistics": {}
} |
Curl
curl -X POST 'https://undefined/reporting-api/v1/reports/:name/versions/:version/report-data?start=&end=&interval=?start=&end=&interval=&dataWrapNumberOfItems=&dataWrapLabel=&accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"filters":{"ip_version":["ipv4"],"traffic_type":["standard_secure"]},"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"],"objectIds":["536194","536198","539651","539798","539987"]}'
ENDPOINTS