ecresponse-by-time report

The following shows how to generate the ecresponse-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 number of completed origin or edge requests per second, aggregated for each category of HTTP status code, 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: 1 year

Available metrics

Metric Description
Data metrics
edgeRequests0xxPerSecond The number of edge requests per second with 0xx status code.
edgeRequests1xxPerSecond The number of edge requests per second with 1xx status code.
edgeRequests2xxPerSecond The number of edge requests per second with 2xx status code.
edgeRequests3xxPerSecond The number of edge requests per second with 3xx status code.
edgeRequests4xxPerSecond The number of edge requests per second with 4xx status code.
edgeRequests5xxPerSecond The number of edge requests per second with 5xx status code.
originRequests0xxPerSecond The number of origin requests per second with 0xx status code.
originRequests1xxPerSecond The number of origin requests per second with 1xx status code.
originRequests2xxPerSecond The number of origin requests per second with 2xx status code.
originRequests3xxPerSecond The number of origin requests per second with 3xx status code.
originRequests4xxPerSecond The number of origin requests per second with 4xx status code.
originRequests5xxPerSecond The number of origin requests per second with 5xx status code.

Sample report

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

Sample: /reporting-api/v1/reports/ecresponse-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.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgeRequests0xxPerSecond",
        "edgeRequests1xxPerSecond",
        "edgeRequests2xxPerSecond",
        "edgeRequests3xxPerSecond",
        "edgeRequests4xxPerSecond",
        "edgeRequests5xxPerSecond",
        "originRequests0xxPerSecond",
        "originRequests1xxPerSecond",
        "originRequests2xxPerSecond",
        "originRequests3xxPerSecond",
        "originRequests4xxPerSecond",
        "originRequests5xxPerSecond"
    ]
}

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

Sample: /reporting-api/v1/reports/ecresponse-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=edgeRequests0xxPerSecond%2CedgeRequests1xxPerSecond

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 edgeRequests0xxPerSecond,edgeRequests1xxPerSecond 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": "ecresponse-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": "edgeRequests0xxPerSecond",
                "label": "Edge Requests 0xx/Sec"
            },
            {
                "name": "edgeRequests1xxPerSecond",
                "label": "Edge Requests 1xx/Sec"
            },
            {
                "name": "edgeRequests2xxPerSecond",
                "label": "Edge Requests 2xx/Sec"
            },
            {
                "name": "edgeRequests3xxPerSecond",
                "label": "Edge Requests 3xx/Sec"
            },
            {
                "name": "edgeRequests4xxPerSecond",
                "label": "Edge Requests 4xx/Sec"
            },
            {
                "name": "edgeRequests5xxPerSecond",
                "label": "Edge Requests 5xx/Sec"
            },
            {
                "name": "originRequests0xxPerSecond",
                "label": "Origin Requests 0xx/Sec"
            },
            {
                "name": "originRequests1xxPerSecond",
                "label": "Origin Requests 1xx/Sec"
            },
            {
                "name": "originRequests2xxPerSecond",
                "label": "Origin Requests 2xx/Sec"
            },
            {
                "name": "originRequests3xxPerSecond",
                "label": "Origin Requests 3xx/Sec"
            },
            {
                "name": "originRequests4xxPerSecond",
                "label": "Origin Requests 4xx/Sec"
            },
            {
                "name": "originRequests5xxPerSecond",
                "label": "Origin Requests 5xx/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgeRequests0xxPerSecond": "3909.076937",
            "edgeRequests1xxPerSecond": "1495.82999",
            "edgeRequests2xxPerSecond": "2800.790499",
            "edgeRequests3xxPerSecond": "1405.643883",
            "edgeRequests4xxPerSecond": "3130.590073",
            "edgeRequests5xxPerSecond": "2409.28308",
            "originRequests0xxPerSecond": "2431.760787",
            "originRequests1xxPerSecond": "2341.056103",
            "originRequests2xxPerSecond": "3531.247957",
            "originRequests3xxPerSecond": "2551.93318",
            "originRequests4xxPerSecond": "802.310336",
            "originRequests5xxPerSecond": "801.939164"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgeRequests0xxPerSecond": "2001.05109",
            "edgeRequests1xxPerSecond": "2142.341958",
            "edgeRequests2xxPerSecond": "3622.964401",
            "edgeRequests3xxPerSecond": "1841.506144",
            "edgeRequests4xxPerSecond": "393.600755",
            "edgeRequests5xxPerSecond": "632.844132",
            "originRequests0xxPerSecond": "2217.907003",
            "originRequests1xxPerSecond": "2804.488288",
            "originRequests2xxPerSecond": "2884.363793",
            "originRequests3xxPerSecond": "4573.182754",
            "originRequests4xxPerSecond": "3877.022132",
            "originRequests5xxPerSecond": "1121.880528"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgeRequests0xxPerSecond": "4633.546795",
            "edgeRequests1xxPerSecond": "2558.292963",
            "edgeRequests2xxPerSecond": "4867.57745",
            "edgeRequests3xxPerSecond": "3780.094147",
            "edgeRequests4xxPerSecond": "1855.100164",
            "edgeRequests5xxPerSecond": "2102.094739",
            "originRequests0xxPerSecond": "3767.799343",
            "originRequests1xxPerSecond": "4369.441925",
            "originRequests2xxPerSecond": "138.899487",
            "originRequests3xxPerSecond": "1322.034075",
            "originRequests4xxPerSecond": "2869.979753",
            "originRequests5xxPerSecond": "1021.393168"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgeRequests0xxPerSecond": "2680.927498",
            "edgeRequests1xxPerSecond": "1087.85026",
            "edgeRequests2xxPerSecond": "1475.157172",
            "edgeRequests3xxPerSecond": "184.079907",
            "edgeRequests4xxPerSecond": "609.206883",
            "edgeRequests5xxPerSecond": "2782.540177",
            "originRequests0xxPerSecond": "1801.991158",
            "originRequests1xxPerSecond": "2753.097265",
            "originRequests2xxPerSecond": "455.396415",
            "originRequests3xxPerSecond": "2720.874673",
            "originRequests4xxPerSecond": "615.153487",
            "originRequests5xxPerSecond": "931.492017"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

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

#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,edgeRequests0xxPerSecond,edgeRequests1xxPerSecond,edgeRequests2xxPerSecond,edgeRequests3xxPerSecond,edgeRequests4xxPerSecond,edgeRequests5xxPerSecond,originRequests0xxPerSecond,originRequests1xxPerSecond,originRequests2xxPerSecond,originRequests3xxPerSecond,originRequests4xxPerSecond,originRequests5xxPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,3909.076937,1495.82999,2800.790499,1405.643883,3130.590073,2409.28308,2431.760787,2341.056103,3531.247957,2551.93318,802.310336,801.939164
2020-06-26T13:45:00Z,2001.05109,2142.341958,3622.964401,1841.506144,393.600755,632.844132,2217.907003,2804.488288,2884.363793,4573.182754,3877.022132,1121.880528
2020-06-26T13:50:00Z,4633.546795,2558.292963,4867.57745,3780.094147,1855.100164,2102.094739,3767.799343,4369.441925,138.899487,1322.034075,2869.979753,1021.393168
2020-06-26T13:55:00Z,2680.927498,1087.85026,1475.157172,184.079907,609.206883,2782.540177,1801.991158,2753.097265,455.396415,2720.874673,615.153487,931.492017
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "ecresponse-by-time",
    "description": "The number of completed origin or edge requests per second, aggregated for each category of HTTP status code, for use in Event Center.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredRoles": [
        "None"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeRequests0xxPerSecond",
            "description": "The number of edge requests per second with 0xx status code.",
            "label": "Edge Requests 0xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeRequests1xxPerSecond",
            "description": "The number of edge requests per second with 1xx status code.",
            "label": "Edge Requests 1xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeRequests2xxPerSecond",
            "description": "The number of edge requests per second with 2xx status code.",
            "label": "Edge Requests 2xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeRequests3xxPerSecond",
            "description": "The number of edge requests per second with 3xx status code.",
            "label": "Edge Requests 3xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeRequests4xxPerSecond",
            "description": "The number of edge requests per second with 4xx status code.",
            "label": "Edge Requests 4xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeRequests5xxPerSecond",
            "description": "The number of edge requests per second with 5xx status code.",
            "label": "Edge Requests 5xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests0xxPerSecond",
            "description": "The number of origin requests per second with 0xx status code.",
            "label": "Origin Requests 0xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests1xxPerSecond",
            "description": "The number of origin requests per second with 1xx status code.",
            "label": "Origin Requests 1xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests2xxPerSecond",
            "description": "The number of origin requests per second with 2xx status code.",
            "label": "Origin Requests 2xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests3xxPerSecond",
            "description": "The number of origin requests per second with 3xx status code.",
            "label": "Origin Requests 3xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests4xxPerSecond",
            "description": "The number of origin requests per second with 4xx status code.",
            "label": "Origin Requests 4xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "originRequests5xxPerSecond",
            "description": "The number of origin requests per second with 5xx status code.",
            "label": "Origin Requests 5xx/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 366,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/ecresponse-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/ecresponse-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/ecresponse-by-time/versions/1/report-data"
        }
    ]
}