imhits-by-browser report

The following shows how to generate the imhits-by-browser 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 browser 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.
edgeImageHitsPercent The percentage of requests for the associated URL as compared to all requests.

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/imhits-by-browser/versions/1/report-data{?start,end}

Sample: /reporting-api/v1/reports/imhits-by-browser/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z

Object type: Query

Download schema: report-request-schema.json

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",
        "edgeImageHitsPercent"
    ],
    "filters": {
        "token_policy": [
            "577597",
            "577595"
        ]
    }
}

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

Sample: /reporting-api/v1/reports/imhits-by-browser/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=edgeImageHits%2CedgeImageHitsPercent&filters=token_policy%3D577598%2Ctoken_policy%3D577596

Query parameters

Parameter Type Sample Description
Required
start String 2020-05-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.
end String 2020-06-01T00:00:00Z Specifies if unavailable reports should be shown.
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,edgeImageHitsPercent 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=577598,token_policy=577596 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": "imhits-by-browser",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "browser_family"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "token_policy",
                "values": [
                    "577597",
                    "577598"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "browser_family"
            },
            {
                "name": "edgeImageHits",
                "label": "Edge Hits"
            },
            {
                "name": "edgeImageHitsPercent",
                "label": "Edge Hits Percent"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "browser_family": "gecko",
            "edgeImageHits": "4048",
            "edgeImageHitsPercent": "50"
        },
        {
            "browser_family": "opera",
            "edgeImageHits": "4669",
            "edgeImageHitsPercent": "26"
        },
        {
            "browser_family": "safari",
            "edgeImageHits": "2821",
            "edgeImageHitsPercent": "0"
        },
        {
            "browser_family": "firefox",
            "edgeImageHits": "2525",
            "edgeImageHitsPercent": "1"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,imhits-by-browser
version,1
source,imhits-by-browser/versions/1
groupBy,browser_family
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
token_policy,577597,577598
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
browser_family,edgeImageHits,edgeImageHitsPercent
#COLUMNS_END

#DATA_START
gecko,4048,50
opera,4669,26
safari,2821,0
firefox,2525,1
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/imhits-by-browser/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "imhits-by-browser",
    "description": "Provides hits data for images configured to use Image Manager at the browser level.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "Image Manager"
    ],
    "requiredRoles": [
        "Image Manager Report - View"
    ],
    "available": true,
    "metrics": [
        {
            "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": "edgeImageHits",
            "description": "The number of requests for images that use Image Manager.",
            "label": "Edge Hits",
            "unit": "COUNT",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "browser_family"
    ],
    "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-reports-executor-api/v1/reports/imhits-by-browser/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/imhits-by-browser/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/imhits-by-browser/versions/1/report-data"
        }
    ]
}