The following shows how to generate the ipa-traffic-by-time report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides data that is associated with the traffic between an origin web server or a set of origins.

Business object: cpcode

Data available for: 1 year

Required products: IP Application Accelerator

Available metrics

Available filters

POST request

POST /reporting-api/v1/reports/ipa-traffic-by-time/versions/1/report-data{?start,​end}

Sample: /reporting-api/v1/reports/ipa-traffic-by-time/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "concurrentUsers",
        "concurrentUsersLatest",
        "concurrentUsersMax",
        "incomingBitsPerSecond",
        "incomingBytesPercent",
        "incomingBytesTotal",
        "outgoingBitsPerSecond",
        "outgoingBytesPercent",
        "outgoingBytesTotal",
        "throughputBitsPerSecondLatest",
        "throughputBitsPerSecondMax"
    ],
    "filters": {
        "acceleratedhostname": [
            "img.example.com",
            "blog.example.com"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/ipa-traffic-by-time/versions/1/report-data{?start,​end,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/ipa-traffic-by-time/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=concurrentUsers%2CconcurrentUsersLatest​&filters​=acceleratedhostname%3Dm.example.com%2Cacceleratedhostname%3Dwww.example.com

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "ipa-traffic-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "acceleratedhostname",
                "values": [
                    "img.example.com",
                    "blog.example.com"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "concurrentUsers",
                "label": "Concurrent Users"
            },
            {
                "name": "incomingBitsPerSecond",
                "label": "Incoming Traffic Throughput"
            },
            {
                "name": "outgoingBitsPerSecond",
                "label": "Outgoing Traffic Throughput"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2019-05-01T00:00:00Z",
            "concurrentUsers": "4663",
            "incomingBitsPerSecond": "896.484142",
            "outgoingBitsPerSecond": "3936.1941"
        },
        {
            "startdatetime": "2019-05-01T00:00:10Z",
            "concurrentUsers": "4501",
            "incomingBitsPerSecond": "4486.217572",
            "outgoingBitsPerSecond": "3139.406102"
        },
        {
            "startdatetime": "2019-05-01T00:00:20Z",
            "concurrentUsers": "809",
            "incomingBitsPerSecond": "3984.509759",
            "outgoingBitsPerSecond": "4456.070039"
        },
        {
            "startdatetime": "2019-05-01T00:00:30Z",
            "concurrentUsers": "1972",
            "incomingBitsPerSecond": "3517.158516",
            "outgoingBitsPerSecond": "1525.54396"
        }
    ],
    "summaryStatistics": {
        "concurrentUsersLatest": {
            "value": "2930",
            "details": {}
        },
        "concurrentUsersMax": {
            "value": "3412",
            "details": {}
        },
        "incomingBytesPercent": {
            "value": "44",
            "details": {}
        },
        "incomingBytesTotal": {
            "value": "3239",
            "details": {}
        },
        "outgoingBytesPercent": {
            "value": "50",
            "details": {}
        },
        "outgoingBytesTotal": {
            "value": "3860",
            "details": {}
        },
        "throughputBitsPerSecondLatest": {
            "value": "518.845595",
            "details": {}
        },
        "throughputBitsPerSecondMax": {
            "value": "3014.832969",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​ipa-traffic-by-time
version,​1
source,​ipa-traffic-by-time/versions/1
groupBy,​startdatetime
start,​2020-05-01T00:00:00Z
end,​2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,​4
objectType,​cpcode
objectIds,​55232,​23433,​32433
acceleratedhostname,​img.example.com,​blog.example.com
#METADATA_END

#SUMMARYSTATISTICS_START
concurrentUsersLatest,​2930
concurrentUsersMax,​3412
incomingBytesPercent,​44
incomingBytesTotal,​3239
outgoingBytesPercent,​50
outgoingBytesTotal,​3860
throughputBitsPerSecondLatest,​518.845595
throughputBitsPerSecondMax,​3014.832969
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​concurrentUsers,​incomingBitsPerSecond,​outgoingBitsPerSecond
#COLUMNS_END

#DATA_START
2019-05-01T00:00:00Z,4663,​896.484142,​3936.1941
2019-05-01T00:00:10Z,4501,​4486.217572,​3139.406102
2019-05-01T00:00:20Z,809,​3984.509759,​4456.070039
2019-05-01T00:00:30Z,1972,​3517.158516,​1525.54396
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the ipa-traffic-by-time report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/ipa-traffic-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "ipa-traffic-by-time",
    "description": "Provides data that is associated with the traffic between an origin web server or a set of origins.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "IP Application Accelerator"
    ],
    "requiredRoles": [
        "Pulsar IPA/SXL Read Only"
    ],
    "available": true,
    "metrics": [
        {
            "name": "concurrentUsers",
            "description": "The number of currently connected users.",
            "label": "Concurrent Users",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "concurrentUsersLatest",
            "description": "The most recent number of connections.",
            "label": "Concurrent Users Latest",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "concurrentUsersMax",
            "description": "The highest number of connections.",
            "label": "Concurrent Users Peak",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "incomingBitsPerSecond",
            "description": "The rate of traffic from the client to the origin (Incoming) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals, based on connectivity from Akamai's distributed network to edge nodes on your network. For other services, the estimated number of incoming edge requests per second.",
            "label": "Incoming Traffic Throughput",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "incomingBytesPercent",
            "description": "The portion of traffic volume from the client to the origin (Incoming) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals, based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Total Incoming Traffic Volume Percentage",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "incomingBytesTotal",
            "description": "The total volume of traffic from the client to the origin (Incoming) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals, based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Total Incoming Traffic Volume",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "outgoingBitsPerSecond",
            "description": "The rate of traffic to the client from the origin (Outgoing) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals. Based on connectivity from Akamai's distributed network to edge nodes on your network. For other services, the estimated number of outgoing edge requests.",
            "label": "Outgoing Traffic Throughput",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "outgoingBytesPercent",
            "description": "The portion of traffic volume to the client from the origin (Outgoing) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals. Based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Total Outgoing Traffic Volume Percentage",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "outgoingBytesTotal",
            "description": "The total volume of traffic to the client from the origin (Outgoing) for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals. Based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Total Outgoing Traffic Volume",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "throughputBitsPerSecondLatest",
            "description": "The latest rate of traffic from the client to the origin (Incoming) and the rate of traffic to the client from the origin (Outgoing), for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals. Based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Latest Total Throughput",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "throughputBitsPerSecondMax",
            "description": "The highest rate of traffic from the client to the origin (Incoming) and the rate of traffic to the client from the origin (Outgoing), for origins that are served by associated Sureroute IP (SRIP) endpoints, converted into bits per second at 5-minute intervals. Based on connectivity from Akamai's distributed network to edge nodes on your network.",
            "label": "Peak Total Throughput",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "acceleratedhostname",
            "type": "STRING",
            "description": "A unique configuration for a hostname.",
            "required": false
        }
    ],
    "intervals": [
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 9000,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/ipa-traffic-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/ipa-traffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/ipa-traffic-by-time/versions/1/report-data"
        }
    ]
}