Akamai APIs API Documentation
Get a report type
GET https://{{host}}/reporting-api/v1/reports/:name/versions/:version
Get a specific version of a report type.
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
| {
"available": true,
"businessObjectName": "cpcode",
"dataRetentionDays": 92,
"deprecated": false,
"filters": [
{
"name": "slot",
"required": false,
"type": "int"
}
],
"groupBy": [
"startdatetime"
],
"groupOutlyingValues": {
"enabled": false
},
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"links": [
{
"href": "/reporting-api/v1/reports/ipatraffic-by-time/versions/3",
"rel": "self"
},
{
"href": "/reporting-api/v1/reports/ipatraffic-by-time/versions",
"rel": "versions"
},
{
"href": "/reporting-api/v1/reports",
"rel": "all-reports"
},
{
"href": "/reporting-api/v1/reports/ipatraffic-by-time/versions/3/report-data",
"rel": "execute-report"
}
],
"metrics": [
{
"label": "Concurrent Users",
"name": "concurrentUsers",
"summaryStatistic": false,
"unit": "COUNT"
},
{
"label": "Concurrent Users Latest",
"name": "concurrentUsersLatest",
"summaryStatistic": true,
"unit": "COUNT"
},
{
"label": "Concurrent Users Peak",
"name": "concurrentUsersMax",
"summaryStatistic": true,
"unit": "COUNT"
},
{
"label": "Incoming Traffic Throughput",
"name": "incomingBitsPerSecond",
"summaryStatistic": false,
"unit": "BIT_PER_SECOND"
},
{
"label": "Total Incoming Traffic Volume Percentage",
"name": "incomingBytesPercent",
"summaryStatistic": true,
"unit": "RATIO"
},
{
"label": "Total Incoming Traffic Volume",
"name": "incomingBytesTotal",
"summaryStatistic": true,
"unit": "BYTE"
},
{
"label": "Outgoing Traffic Throughput",
"name": "outgoingBitsPerSecond",
"summaryStatistic": false,
"unit": "BIT_PER_SECOND"
},
{
"label": "Total Outgoing Traffic Volume Percentage",
"name": "outgoingBytesPercent",
"summaryStatistic": true,
"unit": "RATIO"
},
{
"label": "Total Outgoing Traffic Volume",
"name": "outgoingBytesTotal",
"summaryStatistic": true,
"unit": "BYTE"
},
{
"label": "Latest Total Throughput",
"name": "throughputBitsPerSecondLatest",
"summaryStatistic": true,
"unit": "BIT_PER_SECOND"
},
{
"label": "Peak Total Throughput",
"name": "throughputBitsPerSecondMax",
"summaryStatistic": true,
"unit": "BIT_PER_SECOND"
}
],
"name": "ipatraffic-by-time",
"outputType": "FLAT",
"requiredProducts": [
"IP Application Accelerator"
],
"requiredRoles": [
"Pulsar IPA/SXL Read Only"
],
"status": "PUBLISHED",
"supportsPagination": false,
"timeBased": true,
"version": 3
} |
Curl
curl -X GET 'https://undefined/reporting-api/v1/reports/:name/versions/:version?accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS