🚧

The imtophiturls-by-url report is being discontinued

This report is deprecated and will be deactivated in Q1 2025. As an alternative, use the new delivery/ivm/image-urls report, based on the Reporting API v2.

The following shows how to generate the imtophiturls-by-url 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 URL volume data for images configured to use Image Manager, by URL.

Business object: cpcode

Data available for: 92 days

Required products: Image Manager

Available metrics

Available filters

POST request

POST /reporting-api/v1/reports/imtophiturls-by-url/versions/4/report-data{?start,​end}

Sample: /reporting-api/v1/reports/imtophiturls-by-url/versions/4/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "edgeImageHits"
    ],
    "filters": {
        "token_policy": [
            "577597",
            "577599"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/imtophiturls-by-url/versions/4/report-data{?start,​end,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/imtophiturls-by-url/versions/4/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=edgeImageHits​&filters​=token_policy%3D577599%2Ctoken_policy%3D577597

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "imtophiturls-by-url",
        "version": "4",
        "outputType": "FLAT",
        "groupBy": [
            "url"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "token_policy",
                "values": [
                    "577599",
                    "577598"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "url"
            },
            {
                "name": "edgeImageHits",
                "label": "Edge Hits"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "url": "example.com/static/html",
            "edgeImageHits": "3699"
        },
        {
            "url": "stream.example.com/subscribe",
            "edgeImageHits": "3806"
        },
        {
            "url": "example.com/static/css",
            "edgeImageHits": "3279"
        },
        {
            "url": "stream.example.com/live",
            "edgeImageHits": "1721"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​imtophiturls-by-url
version,​4
source,​imtophiturls-by-url/versions/4
groupBy,​url
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,​577598
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
url,​edgeImageHits
#COLUMNS_END

#DATA_START
example.com/static/html,​3699
stream.example.com/subscribe,​3806
example.com/static/css,​3279
stream.example.com/live,​1721
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/imtophiturls-by-url/versions/4

Status 200 application/json

Response body:

{
    "name": "imtophiturls-by-url",
    "description": "Provides URL volume data for images configured to use Image Manager, by URL.",
    "businessObjectName": "cpcode",
    "version": 4,
    "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": [
        "url"
    ],
    "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/imtophiturls-by-url/versions/4"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/imtophiturls-by-url/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/imtophiturls-by-url/versions/4/report-data"
        }
    ]
}