The imhits-by-policyandwidth report is being discontinued
This report is deprecated and will be deactivated in Q1 2025. As an alternative, use the new delivery/ivm/image-policy-stats report, based on the Reporting API v2.
The following shows how to generate the imhits-by-policyandwidth 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 hits data for images configured to use Image Manager at the token policy and image width level.
Business object: cpcode
Data available for: 92 days
Required products: Image Manager
Available metrics
| Metric | Description |
|---|---|
| Data metrics | |
edgeImageHits | The number of requests for images that use Image Manager. |
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/imhits-by-policyandwidth/versions/1/report-data{?start,end}
Sample: /reporting-api/v1/reports/imhits-by-policyandwidth/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": [
"edgeImageHits"
],
"filters": {
"token_policy": [
"577599",
"577595"
]
}
}
GET request
GET /reporting-api/v1/reports/imhits-by-policyandwidth/versions/1/report-data{?start,end,objectIds,allObjectIds,metrics,filters}
Sample: /reporting-api/v1/reports/imhits-by-policyandwidth/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=edgeImageHits&filters=token_policy%3D577597%2Ctoken_policy%3D577595
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 | edgeImageHits | 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=577597,token_policy=577595 | 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": "imhits-by-policyandwidth",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"token_policy",
"final_width"
],
"start": "2020-05-01T00:00:00Z",
"end": "2020-06-01T00:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "token_policy",
"values": [
"577599",
"577595"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "token_policy"
},
{
"name": "groupBy",
"label": "final_width"
},
{
"name": "edgeImageHits",
"label": "Edge Hits"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"token_policy": "577597",
"final_width": 1024,
"edgeImageHits": "426"
},
{
"token_policy": "577598",
"final_width": 1280,
"edgeImageHits": "1802"
},
{
"token_policy": "577599",
"final_width": 1366,
"edgeImageHits": "3585"
},
{
"token_policy": "577595",
"final_width": 1600,
"edgeImageHits": "4763"
}
],
"summaryStatistics": {}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,imhits-by-policyandwidth
version,1
source,imhits-by-policyandwidth/versions/1
groupBy,token_policy,final_width
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
token_policy,577599,577595
#METADATA_END
#SUMMARYSTATISTICS_START
#SUMMARYSTATISTICS_END
#COLUMNS_START
token_policy,final_width,edgeImageHits
#COLUMNS_END
#DATA_START
577597,1024,426
577598,1280,1802
577599,1366,3585
577595,1600,4763
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the imhits-by-policyandwidth report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/imhits-by-policyandwidth/versions/1
Status 200 application/json
Response body:
{
"name": "imhits-by-policyandwidth",
"description": "Provides hits data for images configured to use Image Manager at the token policy and image width 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": "edgeImageHits",
"description": "The number of requests for images that use Image Manager.",
"label": "Edge Hits",
"unit": "COUNT",
"summaryStatistic": false
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"token_policy",
"final_width"
],
"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/imhits-by-policyandwidth/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/imhits-by-policyandwidth/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/imhits-by-policyandwidth/versions/1/report-data"
}
]
}