estimatedectraffic-by-time

The following shows how to generate the estimatedectraffic-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

The estimated origin and edge traffic data for given CP codes, for use in 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: 4 days

Available metrics

MetricDescription
Data metrics
edgeBitsPerSecondThe edge bandwidth for given objects and filters.
edgeHitsPerSecondThe number of edge requests per second for given objects and filters.
originBitsPerSecondThe origin bandwidth for given objects and filters.
originHitsPerSecondThe number of origin requests per second for given objects and filters.
Summary metrics
edgeBitsPerSecondMaxThe peak edge bandwidth for given objects and filters.
edgeBytesTotalThe total volume of edge traffic for given objects and filters.
edgeHitsPerSecondMaxThe peak number of edge requests per second for given objects and filters.
edgeHitsTotalThe total number of edge requests for given objects and filters.
originBitsPerSecondMaxThe peak origin bandwidth for given objects and filters.
originBytesTotalThe total volume of origin traffic for given objects and filters.
originHitsPerSecondMaxThe peak number of origin requests per second for given objects and filters.
originHitsTotalThe total number of origin requests for given objects and filters.

POST request

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

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

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies 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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of cpcode values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgeBitsPerSecond",
        "edgeBitsPerSecondMax",
        "edgeBytesTotal",
        "edgeHitsPerSecond",
        "edgeHitsPerSecondMax",
        "edgeHitsTotal",
        "originBitsPerSecond",
        "originBitsPerSecondMax",
        "originBytesTotal",
        "originHitsPerSecond",
        "originHitsPerSecondMax",
        "originHitsTotal"
    ]
}

GET request

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

Sample: /reporting-api/v1/reports/estimatedectraffic-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​=edgeBitsPerSecond%2CedgeBitsPerSecondMax

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs 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.
objectIdsString55232,​23433,​32433As 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.
metricsStringedgeBitsPerSecond,​edgeBitsPerSecondMaxSpecifies 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.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "estimatedectraffic-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": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "edgeBitsPerSecond",
                "label": "Edge Bits/Sec"
            },
            {
                "name": "edgeHitsPerSecond",
                "label": "Edge Hits/Sec"
            },
            {
                "name": "originBitsPerSecond",
                "label": "Origin Bits/Sec"
            },
            {
                "name": "originHitsPerSecond",
                "label": "Origin Hits/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgeBitsPerSecond": "4215.342908",
            "edgeHitsPerSecond": "4042.500161",
            "originBitsPerSecond": "1159.548789",
            "originHitsPerSecond": "3916.676765"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgeBitsPerSecond": "914.367602",
            "edgeHitsPerSecond": "893.96398",
            "originBitsPerSecond": "1802.593625",
            "originHitsPerSecond": "2570.817615"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgeBitsPerSecond": "4447.253219",
            "edgeHitsPerSecond": "2919.536706",
            "originBitsPerSecond": "2601.276123",
            "originHitsPerSecond": "2265.446917"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgeBitsPerSecond": "2362.270801",
            "edgeHitsPerSecond": "3134.316852",
            "originBitsPerSecond": "2442.288813",
            "originHitsPerSecond": "2896.120718"
        }
    ],
    "summaryStatistics": {
        "edgeBitsPerSecondMax": {
            "value": "2244.436949",
            "details": {}
        },
        "edgeBytesTotal": {
            "value": "2430",
            "details": {}
        },
        "edgeHitsPerSecondMax": {
            "value": "530.912839",
            "details": {}
        },
        "edgeHitsTotal": {
            "value": "741",
            "details": {}
        },
        "originBitsPerSecondMax": {
            "value": "1862.784117",
            "details": {}
        },
        "originBytesTotal": {
            "value": "3064",
            "details": {}
        },
        "originHitsPerSecondMax": {
            "value": "4090.182612",
            "details": {}
        },
        "originHitsTotal": {
            "value": "4126",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​estimatedectraffic-by-time
version,​1
source,​estimatedectraffic-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
#METADATA_END

#SUMMARYSTATISTICS_START
edgeBitsPerSecondMax,​2244.436949
edgeBytesTotal,​2430
edgeHitsPerSecondMax,​530.912839
edgeHitsTotal,​741
originBitsPerSecondMax,​1862.784117
originBytesTotal,​3064
originHitsPerSecondMax,​4090.182612
originHitsTotal,​4126
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​edgeBitsPerSecond,​edgeHitsPerSecond,​originBitsPerSecond,​originHitsPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,4215.342908,​4042.500161,​1159.548789,​3916.676765
2020-06-26T13:45:00Z,914.367602,​893.96398,​1802.593625,​2570.817615
2020-06-26T13:50:00Z,4447.253219,​2919.536706,​2601.276123,​2265.446917
2020-06-26T13:55:00Z,2362.270801,​3134.316852,​2442.288813,​2896.120718
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "estimatedectraffic-by-time",
    "description": "The estimated origin and edge traffic data for given CP codes, for use in Event Center.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredRoles": [
        "None"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeBitsPerSecond",
            "description": "The edge bandwidth for given objects and filters.",
            "label": "Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeBitsPerSecondMax",
            "description": "The peak edge bandwidth for given objects and filters.",
            "label": "Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsPerSecond",
            "description": "The number of edge requests per second for given objects and filters.",
            "label": "Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeHitsPerSecondMax",
            "description": "The peak number of edge requests per second for given objects and filters.",
            "label": "Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeHitsTotal",
            "description": "The total number of edge requests for given objects and filters.",
            "label": "Edge Hits Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "originBitsPerSecond",
            "description": "The origin bandwidth for given objects and filters. ",
            "label": "Origin Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originBitsPerSecondMax",
            "description": "The peak origin bandwidth for given objects and filters.",
            "label": "Origin Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originHitsPerSecond",
            "description": "The number of origin requests per second for given objects and filters.",
            "label": "Origin Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originHitsPerSecondMax",
            "description": "The peak number of origin requests per second for given objects and filters. ",
            "label": "Origin Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "originHitsTotal",
            "description": "The total number of origin requests for given objects and filters.",
            "label": "Origin Hits Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeBytesTotal",
            "description": "The total volume of edge traffic for given objects and filters.",
            "label": "Edge Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "originBytesTotal",
            "description": "The total volume of origin traffic for given objects and filters.",
            "label": "Origin Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 4,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/estimatedectraffic-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/estimatedectraffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/estimatedectraffic-by-time/versions/1/report-data"
        }
    ]
}