Akamai APIs API Documentation
Get report options
GET https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report
Returns available options to generate the report.
Body
PARAM
| Key | Datatype | Required | Description |
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 |
Accept
|
string |
RESPONSES
status OK
| {
"defaults": {
"defaultDimensions": [
"hostname",
"responseCode"
],
"defaultMetrics": [
"edgeHitsSum",
"edgeBytesSum"
],
"defaultSortBys": [
{
"name": "hostname",
"sortOrder": "ASCENDING"
},
{
"name": "edgeHitsSum",
"sortOrder": "DESCENDING"
}
],
"defaultTimeRange": {
"end": "now - 9min 1sec",
"start": "now - 19min"
}
},
"dimensions": [
{
"authorizable": false,
"filterType": "TEXT",
"filterable": false,
"mandatory": false,
"name": "time5minutes",
"type": "TIMESTAMP_SEC"
},
{
"authorizable": false,
"filterType": "TEXT",
"filterable": false,
"mandatory": false,
"name": "time1hour",
"type": "TIMESTAMP_SEC"
},
{
"authorizable": false,
"filterType": "TEXT",
"filterable": false,
"mandatory": false,
"name": "time1day",
"type": "TIMESTAMP_SEC"
},
{
"authorizable": true,
"filterType": "TEXT",
"filterable": true,
"mandatory": false,
"name": "cpcode",
"type": "LONG"
},
{
"authorizable": false,
"filterType": "TEXT",
"filterable": true,
"mandatory": false,
"name": "hostname",
"type": "STRING"
},
{
"authorizable": false,
"filterType": "TEXT",
"filterable": true,
"mandatory": false,
"name": "responseCode",
"type": "LONG"
},
{
"authorizable": false,
"filterEnumValues": [
"0xx",
"1xx",
"2xx",
"3xx",
"4xx",
"5xx",
"6xx"
],
"filterType": "ENUM",
"filterable": true,
"mandatory": false,
"name": "responseClass",
"type": "STRING"
},
{
"authorizable": false,
"filterEnumValues": [
"error",
"success"
],
"filterType": "ENUM",
"filterable": true,
"mandatory": false,
"name": "responseStatus",
"type": "STRI Curl curl -X GET 'https://host/reporting-api/v2/reports/:productFamily/:reportingArea/:report?accountSwitchKey=' -H 'Accept: application/json' ENDPOINTS |