🚧

The upsrtraffic-by-time report is being discontinued

This report is deprecated and will be deactivated on May 14, 2025.

The following shows how to generate the upsrtraffic-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 the percentage of traffic for which SureRoute provided a faster route for responses. Since this report only produces daily data, the only valid interval value is DAY.

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: 7 days

Required products: Dynamic Site Accelerator, Rich Media Accelerator, Terra Alta Enterprise Accelerator, Kona Site Defender, OTA Updates, Ion, App & API Protector, ​Akamai​ Cloud Catalyst, or Web Application Protector

Available metrics

POST request

POST /reporting-api/v1/reports/upsrtraffic-by-time/versions/2/report-data{?start,​end,​interval}

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

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "avgRouteOptimizationPercent",
        "avgRouteOptimizationPercentMax",
        "avgRouteOptimizationPercentMin",
        "avgRouteOptimizationPercentSlope",
        "routeOptimizationPercent"
    ]
}

GET request

GET /reporting-api/v1/reports/upsrtraffic-by-time/versions/2/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics}

Sample: /reporting-api/v1/reports/upsrtraffic-by-time/versions/2/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES​&objectIds​=55232,​23433,​32433​&metrics​=avgRouteOptimizationPercent%2CavgRouteOptimizationPercentMax

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "upsrtraffic-by-time",
        "version": "2",
        "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": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "routeOptimizationPercent",
                "label": "Optimization %"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "routeOptimizationPercent": "63"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "routeOptimizationPercent": "91"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "routeOptimizationPercent": "9"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "routeOptimizationPercent": "70"
        }
    ],
    "summaryStatistics": {
        "avgRouteOptimizationPercent": {
            "value": "37",
            "details": {}
        },
        "avgRouteOptimizationPercentMax": {
            "value": "10",
            "details": {}
        },
        "avgRouteOptimizationPercentMin": {
            "value": "87",
            "details": {}
        },
        "avgRouteOptimizationPercentSlope": {
            "value": "3165",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​upsrtraffic-by-time
version,​2
source,​upsrtraffic-by-time/versions/2
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
#METADATA_END

#SUMMARYSTATISTICS_START
avgRouteOptimizationPercent,​37
avgRouteOptimizationPercentMax,​10
avgRouteOptimizationPercentMin,​87
avgRouteOptimizationPercentSlope,​3165
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​routeOptimizationPercent
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,63
2020-06-26T13:45:00Z,91
2020-06-26T13:50:00Z,9
2020-06-26T13:55:00Z,70
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/upsrtraffic-by-time/versions/2

Status 200 application/json

Response body:

{
    "name": "upsrtraffic-by-time",
    "description": "Provides the percentage of traffic for which SureRoute provided a faster route for responses.  Since this report only produces daily data, the only valid interval value is DAY.",
    "businessObjectName": "cpcode",
    "version": 2,
    "status": "DEPRECATED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredRoles": [
        "Widget Reports - View Only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "avgRouteOptimizationPercent",
            "description": "Average route optimization percentage.",
            "label": "Average Route Optimization %",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "avgRouteOptimizationPercentMin",
            "description": "The average lowest percentage of requests for which SureRoute provided a faster route.",
            "label": "Average Route Optimization % Min",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "avgRouteOptimizationPercentSlope",
            "description": "Average route optimization percentage slope.",
            "label": "Average Route Optimization % Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "avgRouteOptimizationPercentMax",
            "description": "The average highest percentage of requests for which SureRoute provided a faster route.",
            "label": "Average Route Optimization % Max",
            "unit": "RATIO",
            "summaryStatistic": true
        },
        {
            "name": "routeOptimizationPercent",
            "description": "Route optimization percentage.",
            "label": "Optimization %",
            "unit": "RATIO",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/upsrtraffic-by-time/versions/2"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/upsrtraffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/upsrtraffic-by-time/versions/2/report-data"
        }
    ]
}