The imtraffic-by-imagetype report is being discontinued
This report is deprecated and will be deactivated in Q1 2025. As an alternative, use the new delivery/ivm/image-traffic report, based on the Reporting API v2.
The following shows how to generate the imtraffic-by-imagetype 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 at the image type level.
Business object: cpcode
Data available for: 92 days
Required products: Image Manager
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
edgeImageBytes | The volume used during requests for images that use Image Manager. |
edgeImageBytesPercent | The percentage of volume for the associated URL as compared to all requests. |
edgeImageHits | The number of requests for images that use Image Manager. |
edgeImageHitsPercent | The percentage of requests for the associated URL as compared to all requests. |
| Summary metrics | |
totalEdgeImageBytes | Sum of all edge bytes seen during time range |
totalEdgeImageHits | Sum of all edge hits seen during time range. |
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. |
POST request
POST /reporting-api/v1/reports/imtraffic-by-imagetype/versions/1/report-data{?start,end}
Sample: /reporting-api/v1/reports/imtraffic-by-imagetype/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2020-05-01T00:00: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-01T00: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. |
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": [
"edgeImageBytes",
"edgeImageBytesPercent",
"edgeImageHits",
"edgeImageHitsPercent",
"totalEdgeImageBytes",
"totalEdgeImageHits"
],
"filters": {
"token_policy": [
"577595",
"577596"
]
}
}
GET request
GET /reporting-api/v1/reports/imtraffic-by-imagetype/versions/1/report-data{?start,end,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/imtraffic-by-imagetype/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=edgeImageBytes%2CedgeImageBytesPercent&filters=token_policy%3D577596%2Ctoken_policy%3D577599
Query parameters
| Parameter | Type | Sample | Description |
|---|---|---|---|
| Required | |||
start | String | 2022-06-23T13: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 | 2022-06-23T14: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. |
| 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 | edgeImageBytes,edgeImageBytesPercent | 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=577596,token_policy=577599 | 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. |
JSON response
Status 200 application/json
Response body:
{
"metadata": {
"name": "imtraffic-by-imagetype",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"image_type"
],
"start": "2020-05-01T00:00:00Z",
"end": "2020-06-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "token_policy",
"values": [
"577595",
"577597"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "image_type"
},
{
"name": "edgeImageBytes",
"label": "Edge Bytes"
},
{
"name": "edgeImageBytesPercent",
"label": "Edge Bytes Percent"
},
{
"name": "edgeImageHits",
"label": "Edge Hits"
},
{
"name": "edgeImageHitsPercent",
"label": "Edge Hits Percent"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"image_type": "image/x-cmx",
"edgeImageBytes": "2077",
"edgeImageBytesPercent": "74",
"edgeImageHits": "4731",
"edgeImageHitsPercent": "93"
},
{
"image_type": "image/tiff",
"edgeImageBytes": "3790",
"edgeImageBytesPercent": "50",
"edgeImageHits": "2639",
"edgeImageHitsPercent": "84"
},
{
"image_type": "image/x-icon",
"edgeImageBytes": "4875",
"edgeImageBytesPercent": "1",
"edgeImageHits": "3583",
"edgeImageHitsPercent": "30"
},
{
"image_type": "image/cis-cod",
"edgeImageBytes": "4386",
"edgeImageBytesPercent": "10",
"edgeImageHits": "4507",
"edgeImageHitsPercent": "68"
}
],
"summaryStatistics": {
"totalEdgeImageBytes": {
"value": "3434",
"details": {}
},
"totalEdgeImageHits": {
"value": "3827",
"details": {}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,imtraffic-by-imagetype
version,1
source,imtraffic-by-imagetype/versions/1
groupBy,image_type
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
token_policy,577595,577597
#METADATA_END
#SUMMARYSTATISTICS_START
totalEdgeImageBytes,3434
totalEdgeImageHits,3827
#SUMMARYSTATISTICS_END
#COLUMNS_START
image_type,edgeImageBytes,edgeImageBytesPercent,edgeImageHits,edgeImageHitsPercent
#COLUMNS_END
#DATA_START
image/x-cmx,2077,74,4731,93
image/tiff,3790,50,2639,84
image/x-icon,4875,1,3583,30
image/cis-cod,4386,10,4507,68
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the imtraffic-by-imagetype report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/imtraffic-by-imagetype/versions/1
Status 200 application/json
Response body:
{
"name": "imtraffic-by-imagetype",
"description": "Provides traffic data for images configured to use Image Manager at the image type level.",
"businessObjectName": "cpcode",
"version": 1,
"status": "DEPRECATED",
"deprecated": true,
"timeBased": false,
"outputType": "FLAT",
"requiredProducts": [
"Image Manager"
],
"requiredRoles": [
"Image Manager Report - View"
],
"available": true,
"metrics": [
{
"name": "edgeImageBytes",
"description": "The volume used during requests for images that use Image Manager.",
"label": "Edge Bytes",
"unit": "BYTE",
"summaryStatistic": false
},
{
"name": "edgeImageBytesPercent",
"description": "The percentage of volume for the associated URL as compared to all requests.",
"label": "Edge Bytes Percent",
"unit": "RATIO",
"summaryStatistic": false
},
{
"name": "edgeImageHits",
"description": "The number of requests for images that use Image Manager.",
"label": "Edge Hits",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "edgeImageHitsPercent",
"description": "The percentage of requests for the associated URL as compared to all requests.",
"label": "Edge Hits Percent",
"unit": "RATIO",
"summaryStatistic": false
},
{
"name": "totalEdgeImageHits",
"description": "Sum of all edge hits seen during time range.",
"label": "Total Edge Hits",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "totalEdgeImageBytes",
"description": "Sum of all edge bytes seen during time range",
"label": "Total Edge Bytes",
"unit": "BYTE",
"summaryStatistic": true
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"image_type"
],
"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"
],
"dataRetentionDays": 92,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/imtraffic-by-imagetype/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/imtraffic-by-imagetype/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/imtraffic-by-imagetype/versions/1/report-data"
}
]
}