sriptraffic-by-time report

The following shows how to generate the sriptraffic-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 estimated traffic data for IPA/SXL. Applies to traffic tracked by the Event Center.

This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

Business object: cpcode

Data available for: 90 days

Available metrics

Metric Description
Data metrics
connections The estimated number of concurrent IPA/SXL connections.
incomingBitsPerSecond 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.
outgoingBitsPerSecond 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.
Summary metrics
bitsPerSecondMax The highest bandwidth per second.
bytesTotal The total bandwidth used for requests. If using Image Converter, the bandwidth for images configured to use Image Converter.
connectionsMax The peak estimated number of concurrent IPA/SXL connections.

Available filters

Filter Type Description
Optional filters
slot_id Integer 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.

Sample report

POST /reporting-api/v1/reports/sriptraffic-by-time/versions/1/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/sriptraffic-by-time/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies the start of the reported period as an ISO–8601 timestamp with optional time zone. The report includes data that matches the start value’s timestamp.
end String 2020-06-26T14:00:00Z Specifies the end of the reported period as an ISO–8601 timestamp with optional time zone. The report excludes any data that matches the end value’s timestamp.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

Member Type Description
objectIds Array Specifies the set of cpcode values you want to report on.
objectIds Enumeration As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metrics Array The set of desired metrics. If omitted, the report includes all available metrics.
filters Map of Arrays Specifies a set of custom filters, with each filter’s name keying an array with each filter’s set of values.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "bitsPerSecondMax",
        "bytesTotal",
        "connections",
        "connectionsMax",
        "incomingBitsPerSecond",
        "outgoingBitsPerSecond"
    ],
    "filters": {
        "slot_id": [
            "577598",
            "577597"
        ]
    }
}

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

Sample: /reporting-api/v1/reports/sriptraffic-by-time/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=bitsPerSecondMax%2CbytesTotal&filters=slot_id%3D577599%2Cslot_id%3D577595

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies the end of the reported period as an ISO–8601 timestamp with optional time zone. The report excludes any data that matches the end value’s timestamp.
end String 2020-06-26T14:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIds Boolean true As an alternative to objectIds, enabling this generates a report that includes all IDs available for the cpcode objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIds String 55232,23433,32433 As an alternative to allObjectIds, specifies the set of unique IDs for the cpcode objectType you want to report on, formatted as a comma-delimited list.
metrics String bitsPerSecondMax,bytesTotal Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.
filters String slot_id=577599,slot_id=577595 Specifies criteria to filter the report’s data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "sriptraffic-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "slot_id",
                "values": [
                    "577599",
                    "577596"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "connections",
                "label": "IPA/SXL Connections"
            },
            {
                "name": "incomingBitsPerSecond",
                "label": "IPA/SXL Incoming Bits/Sec"
            },
            {
                "name": "outgoingBitsPerSecond",
                "label": "IPA/SXL Outgoing Bits/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "connections": "250",
            "incomingBitsPerSecond": "3580.965472",
            "outgoingBitsPerSecond": "2662.123071"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "connections": "4847",
            "incomingBitsPerSecond": "2030.148112",
            "outgoingBitsPerSecond": "2044.123598"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "connections": "1251",
            "incomingBitsPerSecond": "2230.867892",
            "outgoingBitsPerSecond": "1993.958518"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "connections": "4062",
            "incomingBitsPerSecond": "2262.279697",
            "outgoingBitsPerSecond": "4744.544004"
        }
    ],
    "summaryStatistics": {
        "bitsPerSecondMax": {
            "value": "154.683896",
            "details": {}
        },
        "bytesTotal": {
            "value": "3355",
            "details": {}
        },
        "connectionsMax": {
            "value": "4408",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,sriptraffic-by-time
version,1
source,sriptraffic-by-time/versions/1
groupBy,startdatetime
start,2020-06-26T13:40:00Z
end,2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
slot_id,577599,577596
#METADATA_END

#SUMMARYSTATISTICS_START
bitsPerSecondMax,154.683896
bytesTotal,3355
connectionsMax,4408
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,connections,incomingBitsPerSecond,outgoingBitsPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,250,3580.965472,2662.123071
2020-06-26T13:45:00Z,4847,2030.148112,2044.123598
2020-06-26T13:50:00Z,1251,2230.867892,1993.958518
2020-06-26T13:55:00Z,4062,2262.279697,4744.544004
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/sriptraffic-by-time/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "sriptraffic-by-time",
    "description": "Provides estimated traffic data for IPA/SXL. Applies to traffic tracked by the Event Center.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredRoles": [
        "None"
    ],
    "available": true,
    "metrics": [
        {
            "name": "bitsPerSecondMax",
            "description": "The highest bandwidth per second.",
            "label": "IPA/SXL Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "connections",
            "description": "The estimated number of concurrent IPA/SXL connections.",
            "label": "IPA/SXL Connections",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "connectionsMax",
            "description": "The peak estimated number of concurrent IPA/SXL connections.",
            "label": "IPA/SXL Connections Maximum",
            "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": "IPA/SXL Incoming Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "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": "IPA/SXL Outgoing Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "bytesTotal",
            "description": "The total bandwidth used for requests. If using Image Converter, the bandwidth for images configured to use Image Converter.",
            "label": "IPA/SXL Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "slot_id",
            "type": "int",
            "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.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/sriptraffic-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/sriptraffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/sriptraffic-by-time/versions/1/report-data"
        }
    ]
}