cmreq-by-time report

The following shows how to generate the cmreq-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 HTTP transaction data delivered through the edge platform to your end users.

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

Required products: Cloud Monitor, OTA Updates

Available metrics

Metric Description
Data metrics
requestCountPerSecond The rate of HTTP transactions per second delivered through the edge platform to your end users.
Summary metrics
requestCountPerSecondLatest The most recent rate of HTTP transactions per second delivered through the edge platform to your end users.
requestCountPerSecondMax The highest rate of HTTP transactions per second delivered through the edge platform to your end users.
requestCountTotal The number of HTTP transactions per second delivered through the edge platform to your end users.

Sample report

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

Sample: /reporting-api/v1/reports/cmreq-by-time/versions/1/report-data?start=2020-09-01T13%3A55%3A00Z&end=2020-09-01T14%3A15%3A00Z&interval=FIVE_MINUTES

For other granularity, you need to adjust start and end dates:

Sample with longer interval: /reporting-api/v1/reports/cmreq-by-time/versions/1/report-data?start=2020-05-01&end=2020-09-01&interval=MONTH

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-09-01T13:55: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-09-01T14:15: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.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "requestCountPerSecond",
        "requestCountPerSecondLatest",
        "requestCountPerSecondMax",
        "requestCountTotal"
    ]
}

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

Sample: /reporting-api/v1/reports/cmreq-by-time/versions/1/report-data?start=2020–09–01T13%3A55%3A00Z&end=2020–09–01T14%3A15%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=requestCountPerSecond%2CrequestCountPerSecondLatest

Query parameters

Parameter Type Sample Description
Required
start String 2020-09-01T13:55: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-09-01T14:15: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 requestCountPerSecond,requestCountPerSecondLatest 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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "cmreq-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-09-01T13:55:00Z",
        "end": "2020-09-01T14:15:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "requestCountPerSecond",
                "label": "Requests/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-09-01T13:55:00Z",
            "requestCountPerSecond": "3410.12867"
        },
        {
            "startdatetime": "2020-09-01T14:00:00Z",
            "requestCountPerSecond": "4150.994169"
        },
        {
            "startdatetime": "2020-09-01T14:05:00Z",
            "requestCountPerSecond": "1705.315815"
        },
        {
            "startdatetime": "2020-09-01T14:10:00Z",
            "requestCountPerSecond": "3331.354953"
        }
    ],
    "summaryStatistics": {
        "requestCountPerSecondLatest": {
            "value": "971.560954",
            "details": {}
        },
        "requestCountPerSecondMax": {
            "value": "1324.88182",
            "details": {}
        },
        "requestCountTotal": {
            "value": "4974",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,cmreq-by-time
version,1
source,cmreq-by-time/versions/1
groupBy,startdatetime
start,2020-09-01T13:55:00Z
end,2020-09-01T14:15:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
#METADATA_END

#SUMMARYSTATISTICS_START
requestCountPerSecondLatest,971.560954
requestCountPerSecondMax,1324.88182
requestCountTotal,4974
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,requestCountPerSecond
#COLUMNS_END

#DATA_START
2020-09-01T13:55:00Z,3410.12867
2020-09-01T14:00:00Z,4150.994169
2020-09-01T14:05:00Z,1705.315815
2020-09-01T14:10:00Z,3331.354953
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "cmreq-by-time",
    "description": "Provides HTTP transaction data delivered through the edge platform to your end users.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Cloud Monitor, OTA Updates"
    ],
    "requiredRoles": [
        "EdgeConnect Report - View Only",
        "OTA App User"
    ],
    "available": false,
    "metrics": [
        {
            "name": "requestCountPerSecondMax",
            "description": "The highest rate of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Requests/Sec Peak",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "requestCountPerSecondLatest",
            "description": "The most recent rate of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Requests/Sec Latest",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "requestCountPerSecond",
            "description": "The rate of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Requests/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "requestCountTotal",
            "description": "The number of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Total Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/cmreq-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/cmreq-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/cmreq-by-time/versions/1/report-data"
        }
    ]
}