Akamai APIs API Documentation
Generate a report
POST https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report/data
Produces a report in either JSON or CSV format.
Body
PARAM
| Key | Datatype | Required | Description |
start
|
string | (Optional) Start date in ISO 8601 format. Use this parameter together with `end`, or else replace both with a fixed `timeRange`. | |
end
|
string | (Optional) End date in ISO 8601 format. Use this parameter together with `start`, or else replace both with a fixed `timeRange`. | |
timeRange
|
string | (Optional) __Enum__ Predefined time range, either `LAST_15_MINUTES`, `LAST_30_MINUTES`, `LAST_1_HOUR`, `LAST_3_HOURS`, `LAST_6_HOURS`, `LAST_12_HOURS`, `LAST_1_DAY`, `LAST_2_DAYS`, `LAST_1_WEEK`, `LAST_30_DAYS`, or `LAST_90_DAYS`. Use this as an alternative to a more flexible `start` and `end` time range. Support for specific time range values may vary by report type. See the report documentation under [Available reports](https://techdocs.akamai.com/reporting/reference/available-reports). | |
async
|
string | (Optional) Enables the asynchronous flow to get the data. By default, `false`. | |
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 | < Curl curl -X POST 'https://host/reporting-api/v2/reports/:productFamily/:reportingArea/:report/data?start=&end=&timeRange=&async=&accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dimensions":["hostname","responseCode","time5minutes"],"filters":[{"expression":"50","metricName":"edgeBytesSum","operator":"GREATER_THAN"},{"dimensionName":"hostname","expressions":["example.com","custom.com","origin.com"],"operator":"IN_LIST"}],"limit":1000,"metrics":["edgeBytesSum","edgeHitsSum"],"sortBys":[{"name":"hostname","sortOrder":"ASCENDING"},{"name":"edgeHitsSum","sortOrder":"DESCENDING"}]}' ENDPOINTS |