imtraffic-by-time report

The following shows how to generate the imtraffic-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 traffic data for images configured to use Image Manager.

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: Image Manager

Available metrics

Metric Description
Data metrics
edgeImageBitsPerSecond The rate of volume per second for that image.
edgeImageHitsPerSecond The rate of image requests.
Summary metrics
edgeImageBitsPerSecondLatest The most recent rate of volume per second for that image.
edgeImageBitsPerSecondPeak The highest rate of volume per second for that image.
edgeImageBytesTotal The volume used during the requests for the associated URL.
edgeImageHitsPerSecondLatest The most recent rate of requests (hits) per second for that image.
edgeImageHitsPerSecondPeak The highest rate of image requests.
edgeImageHitsTotal The number of image requests (hits) for that image.

Available filters

Filter Type Description
Optional filters
token_policy String The Image Manager policy for which you want data included. Policies are associated with their API tokens.

Sample report

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

Sample: /reporting-api/v1/reports/imtraffic-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.
filters Map of Arrays Specifies a set of custom filters, with each filter’s name keying an array with each filter’s set of values.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgeImageBitsPerSecond",
        "edgeImageBitsPerSecondLatest",
        "edgeImageBitsPerSecondPeak",
        "edgeImageBytesTotal",
        "edgeImageHitsPerSecond",
        "edgeImageHitsPerSecondLatest",
        "edgeImageHitsPerSecondPeak",
        "edgeImageHitsTotal"
    ],
    "filters": {
        "token_policy": [
            "577596",
            "577597"
        ]
    }
}

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

Sample: /reporting-api/v1/reports/imtraffic-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=edgeImageBitsPerSecond%2CedgeImageBitsPerSecondLatest&filters=token_policy%3D577595%2Ctoken_policy%3D577597

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 edgeImageBitsPerSecond,edgeImageBitsPerSecondLatest 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.
filters String token_policy=577595,token_policy=577597 Specifies criteria to filter the report’s data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. 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": "imtraffic-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": [
            {
                "name": "token_policy",
                "values": [
                    "577597",
                    "577595"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "edgeImageBitsPerSecond",
                "label": "Edge Image Bits/Sec"
            },
            {
                "name": "edgeImageHitsPerSecond",
                "label": "Edge Image Hits/Sec"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "edgeImageBitsPerSecond": "4261.436778",
            "edgeImageHitsPerSecond": "1207.613693"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "edgeImageBitsPerSecond": "4875.219472",
            "edgeImageHitsPerSecond": "3549.684956"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "edgeImageBitsPerSecond": "237.003528",
            "edgeImageHitsPerSecond": "2334.172265"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "edgeImageBitsPerSecond": "4245.311165",
            "edgeImageHitsPerSecond": "3746.916061"
        }
    ],
    "summaryStatistics": {
        "edgeImageBitsPerSecondLatest": {
            "value": "4449.241683",
            "details": {}
        },
        "edgeImageBitsPerSecondPeak": {
            "value": "4918.747753",
            "details": {}
        },
        "edgeImageBytesTotal": {
            "value": "208",
            "details": {}
        },
        "edgeImageHitsPerSecondLatest": {
            "value": "4006.377007",
            "details": {}
        },
        "edgeImageHitsPerSecondPeak": {
            "value": "4584.401764",
            "details": {}
        },
        "edgeImageHitsTotal": {
            "value": "2011",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,imtraffic-by-time
version,1
source,imtraffic-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
token_policy,577597,577595
#METADATA_END

#SUMMARYSTATISTICS_START
edgeImageBitsPerSecondLatest,4449.241683
edgeImageBitsPerSecondPeak,4918.747753
edgeImageBytesTotal,208
edgeImageHitsPerSecondLatest,4006.377007
edgeImageHitsPerSecondPeak,4584.401764
edgeImageHitsTotal,2011
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,edgeImageBitsPerSecond,edgeImageHitsPerSecond
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,4261.436778,1207.613693
2020-06-26T13:45:00Z,4875.219472,3549.684956
2020-06-26T13:50:00Z,237.003528,2334.172265
2020-06-26T13:55:00Z,4245.311165,3746.916061
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "imtraffic-by-time",
    "description": "Provides traffic data for images configured to use Image Manager.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Image Manager"
    ],
    "requiredRoles": [
        "Image Manager Report - View"
    ],
    "available": true,
    "metrics": [
        {
            "name": "edgeImageBitsPerSecondPeak",
            "description": "The highest rate of volume per second for that image.",
            "label": "Edge Image Bits/Sec Peak",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeImageBitsPerSecondLatest",
            "description": "The most recent rate of volume per second for that image.",
            "label": "Edge Image Bits/Sec Latest",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeImageHitsTotal",
            "description": "The number of image requests (hits) for that image.",
            "label": "Edge Image Hits Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "edgeImageHitsPerSecondPeak",
            "description": "The highest rate of image requests.",
            "label": "Edge Image Hits/Sec Peak",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeImageHitsPerSecondLatest",
            "description": "The most recent rate of requests (hits) per second for that image.",
            "label": "Edge Image Hits/Sec Latest",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "edgeImageBitsPerSecond",
            "description": "The rate of volume per second for that image.",
            "label": "Edge Image Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeImageHitsPerSecond",
            "description": "The rate of image requests.",
            "label": "Edge Image Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "edgeImageBytesTotal",
            "description": " The volume used during the requests for the associated URL. ",
            "label": "Edge Image Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "token_policy",
            "type": "string",
            "description": "The Image Manager policy for which you want data included. Policies are associated with their API tokens.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/imtraffic-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/imtraffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/imtraffic-by-time/versions/1/report-data"
        }
    ]
}