The following shows how to generate the cmlogline-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 real-time logging data for your HTTP traffic.

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
`forwardRequestBytesPerSecond`	The total bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`loglineCountPerSecond`	The rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`requestCountPerSecond`	The rate of HTTP transactions per second delivered through the edge platform to your end users.
Summary metrics
`forwardRequestBytesPerSecondLatest`	The most recent bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`forwardRequestBytesPerSecondMax`	The highest bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`forwardRequestBytesTotal`	The total volume of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`loglineCountPerSecondLatest`	The most recent rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`loglineCountPerSecondMax`	The highest rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`loglineCountTotal`	The number of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).
`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.

POST request

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

Sample: /reporting-api/v1/reports/cmlogline-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/cmlogline-by-time/versions/1/report-data?start=2020-05-01&end=2020-09-01&interval=MONTH

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": [
        "forwardRequestBytesPerSecond",
        "forwardRequestBytesPerSecondLatest",
        "forwardRequestBytesPerSecondMax",
        "forwardRequestBytesTotal",
        "loglineCountPerSecond",
        "loglineCountPerSecondLatest",
        "loglineCountPerSecondMax",
        "loglineCountTotal",
        "requestCountPerSecond",
        "requestCountPerSecondLatest",
        "requestCountPerSecondMax",
        "requestCountTotal"
    ]
}

GET request

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

Sample: /reporting-api/v1/reports/cmlogline-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=forwardRequestBytesPerSecond%2CforwardRequestBytesPerSecondLatest

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	`forwardRequestBytesPerSecond,forwardRequestBytesPerSecondLatest`	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.

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "cmlogline-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": "forwardRequestBytesPerSecond",
                "label": "Forward Request Bytes/Sec"
            },
            {
                "name": "loglineCountPerSecond",
                "label": "Log Line Delivery Requests/Sec"
            },
            {
                "name": "requestCountPerSecond",
                "label": "Forward Request/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-09-01T13:55:00Z",
            "forwardRequestBytesPerSecond": "2665.233094",
            "loglineCountPerSecond": "656.654488",
            "requestCountPerSecond": "544.718415"
        },
        {
            "startdatetime": "2020-09-01T14:00:00Z",
            "forwardRequestBytesPerSecond": "4751.884413",
            "loglineCountPerSecond": "1572.198778",
            "requestCountPerSecond": "130.088413"
        },
        {
            "startdatetime": "2020-09-01T14:05:00Z",
            "forwardRequestBytesPerSecond": "4433.494568",
            "loglineCountPerSecond": "4936.527938",
            "requestCountPerSecond": "1684.89414"
        },
        {
            "startdatetime": "2020-09-01T14:10:00Z",
            "forwardRequestBytesPerSecond": "3289.76436",
            "loglineCountPerSecond": "1222.142918",
            "requestCountPerSecond": "1950.080514"
        }
    ],
    "summaryStatistics": {
        "forwardRequestBytesPerSecondLatest": {
            "value": "4885.841496",
            "details": {}
        },
        "forwardRequestBytesPerSecondMax": {
            "value": "2623.254731",
            "details": {}
        },
        "forwardRequestBytesTotal": {
            "value": "821",
            "details": {}
        },
        "loglineCountPerSecondLatest": {
            "value": "4744.751674",
            "details": {}
        },
        "loglineCountPerSecondMax": {
            "value": "4561.83147",
            "details": {}
        },
        "loglineCountTotal": {
            "value": "3081",
            "details": {}
        },
        "requestCountPerSecondLatest": {
            "value": "595.910202",
            "details": {}
        },
        "requestCountPerSecondMax": {
            "value": "1512.013558",
            "details": {}
        },
        "requestCountTotal": {
            "value": "4038",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,cmlogline-by-time
version,1
source,cmlogline-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
forwardRequestBytesPerSecondLatest,4885.841496
forwardRequestBytesPerSecondMax,2623.254731
forwardRequestBytesTotal,821
loglineCountPerSecondLatest,4744.751674
loglineCountPerSecondMax,4561.83147
loglineCountTotal,3081
requestCountPerSecondLatest,595.910202
requestCountPerSecondMax,1512.013558
requestCountTotal,4038
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,forwardRequestBytesPerSecond,loglineCountPerSecond,requestCountPerSecond
#COLUMNS_END

#DATA_START
2020-09-01T13:55:00Z,2665.233094,656.654488,544.718415
2020-09-01T14:00:00Z,4751.884413,1572.198778,130.088413
2020-09-01T14:05:00Z,4433.494568,4936.527938,1684.89414
2020-09-01T14:10:00Z,3289.76436,1222.142918,1950.080514
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "cmlogline-by-time",
    "description": "Provides real-time logging data for your HTTP traffic.",
    "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": "forwardRequestBytesPerSecondMax",
            "description": "The highest bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Forward Request Bytes/Sec Peak",
            "unit": "BYTE_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "requestCountPerSecondMax",
            "description": "The highest rate of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Forward Request/Sec Peak",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "loglineCountPerSecond",
            "description": "The rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Log Line Delivery Requests/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "forwardRequestBytesPerSecondLatest",
            "description": "The most recent bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Forward Request Bytes/Sec Latest",
            "unit": "BYTE_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": "Forward Request/Sec Latest",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "forwardRequestBytesPerSecond",
            "description": "The total bandwidth rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Forward Request Bytes/Sec",
            "unit": "BYTE_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "loglineCountPerSecondLatest",
            "description": "The most recent rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Log Line Delivery 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": "Forward Request/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "forwardRequestBytesTotal",
            "description": "The total volume of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Total Forward Request Bytes",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "loglineCountTotal",
            "description": "The number of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Total Log Line Delivery Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "requestCountTotal",
            "description": "The number of HTTP transactions per second delivered through the edge platform to your end users.",
            "label": "Total Forward Requests",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "loglineCountPerSecondMax",
            "description": "The highest rate of aggregated log lines (forward requests containing HTTP event data at the edge sent in an HTTPS POST request from Akamai edge servers to your origin).",
            "label": "Log Line Delivery Requests/Sec Peak",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/cmlogline-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/cmlogline-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/cmlogline-by-time/versions/1/report-data"
        }
    ]
}