The following shows how to generate the delivery/ivm/video-urls report with the Generate a report POST operation of the Reporting API v2. See also other available reports.

Report definition

Provides URL requests and volume data for videos configured to use Image and Video Manager, by URL.

Data available for: 90 days

Required products: Image and Video Manager

Available metrics

Metric name	Description	Configuration
`hits`	The number of video hits received over the Akamai network.	`type: LONG,` `filterable: true,` `mandatory: false`
`bytes`	The number of bytes of video content delivered over the Akamai network.	`type: LONG,` `filterable: true,` `mandatory: false`
`hits2xx`	The number of requests that returned successful responses.	`type: LONG,` `filterable: true,` `mandatory: false`
`ms2xx`	The number of milliseconds served with successful responses.	`type: LONG,` `filterable: true,` `mandatory: false`
`bytes2xx`	The volume of data served with successful responses.	`type: LONG,` `filterable: true,` `mandatory: false`
`pristineBytes`	The volume of traffic from the origin.	`type: LONG,` `filterable: true,` `mandatory: false`
`averagePristineBytes`	Average size of the original pristine video at your origin.	`type: LONG,` `filterable: true,` `mandatory: false`

Available dimensions

Dimension name	Description	Configuration
`cpcode`	Content provider (CP) code.	`type: LONG,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: true`
`time1day`	Datapoint timestamp for 1 day granularity.	`type: LONG,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: false`
`token`	The Image and Video Manager policy token for which you want data included.	`type: STRING,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: false`
`tokenWithVersion`	The Image and Video Manager policy token with the version for which you want data included.	`type: STRING,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: false`
`url`	A URL of the requested video.	`type: STRING,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: false`
`domain`	A domain of the requested video.	`type: STRING,` `filterable: true,` `mandatory: false,` `filterType: TEXT,` `authorizable: false`

Generate a report

Use the Generate a report POST operation to execute a report.

Follow the API workflows to:

POST request sample

POST /reporting-api/v2/reports/delivery/ivm/video-urls/data?timeRange=LAST_1_WEEK

Available time ranges

For this report, you can use these predefined ranges in the timeRange query parameter:

LAST_1_DAY
LAST_1_WEEK
LAST_30_DAYS
LAST_90_DAYS

Supported filters

This report supports filtering by dimensions and metrics. You can filter by each dimension or metric that is labeled as filterable: true in the report options. See how to use filters.

Request body example


{
   "dimensions": [
       "url",
       "domain",
       "token",
       "time1day"
   ],
   "metrics": [
       "hits",
       "bytes",
       "hits2xx",
       "bytes2xx",
       "ms2xx",
       "pristineBytes",
       "averagePristineBytes"
   ],
   "filters": [
       {
           "dimensionName": "cpcode",
           "operator": "IN_LIST",
           "expressions": [
               "1041081"
           ]
       }
],
   "sortBys": [
       {
           "name": "hits2xx",
           "sortOrder": "DESCENDING"
       }
   ],
   "limit": 1000
}

Default values

These default values apply to all requests, meaning they are used unless you specify otherwise.

Time range. Short relative range of 7 days:
- start. Now - 7 days
- end. Now - 1 day
Metrics:
- hits200
- bytes200
Dimensions:
- url
Filters:
- cpcode. You can use all CP codes to which you are authorized in Control Center. If you don't specify any CP codes in your request, the report shows data for all your available CP codes.
SortBys:
- hits200, DESCENDING

Limits

Each report has some configured limits. If your request has values that exceed the limits, it results in a HTTP 400 Bad Request response. This report has the following limits:

Setting	Limit
Maximum number of dimensions	4
Maximum time range	90 days
Maximum retention of historic data	90 days
Maximum number of values for filters using the `IN_LIST` operator	10000
Maximum length of value for `TEXT` filters	100
Maximum number of data points returned	50000

Rate limiting

This report uses the hit-based rate limiting. The limit is 200 requests per minute.

In the asynchronous flow, you can have 3 queued POST requests at the same time.

Get report options

To get the report metadata through the API, run the GET report options operation.

GET /reporting-api/v2/reports/delivery/ivm/video-urls

The response shows the list of available metrics and dimensions, the default values, and configured limits.

{
    "name": "IVM video url report data",
    "status": "PUBLISHED",
    "metrics": [
        {
            "name": "hits",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "bytes",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "hits2xx",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "ms2xx",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "bytes2xx",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "pristineBytes",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        },
        {
            "name": "averagePristineBytes",
            "type": "LONG",
            "filterable": true,
            "mandatory": false
        }
    ],
    "dimensions": [
        {
            "name": "time1day",
            "type": "LONG",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": false
        },
        {
            "name": "cpcode",
            "type": "LONG",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": true
        },
        {
            "name": "token",
            "type": "STRING",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": false
        },
        {
            "name": "tokenWithVersion",
            "type": "STRING",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": false
        },
        {
            "name": "url",
            "type": "STRING",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": false
        },
        {
            "name": "domain",
            "type": "STRING",
            "filterable": true,
            "mandatory": false,
            "filterType": "TEXT",
            "authorizable": false
        }
    ],
    "predefinedTimeRanges": [
        "LAST_1_DAY",
        "LAST_1_WEEK",
        "LAST_30_DAYS",
        "LAST_90_DAYS"
    ],
    "defaults": {
        "defaultTimeRange": {
            "start": "now - 7 days",
            "end": "now - 1 day"
        },
        "defaultMetrics": [
            "hits2xx",
            "bytes2xx"
        ],
        "defaultDimensions": [
            "url"
        ],
        "defaultSortBys": [
            {
                "name": "hits2xx",
                "sortOrder": "DESCENDING"
            }
        ]
    },
    "limits": {
        "maxDimensions": 4,
        "maxDateRangeInDays": 90,
        "maxRetentionInDays": 90,
        "inListFilterMaxValues": 10000,
        "textFilterMaxLength": 100,
        "dataPointsLimit": 50000
    },
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v2/reports/delivery/ivm/video-urls",
            "describedBy": "/reporting-api/v2/reports/schema",
            "allow": [
                "GET"
            ]
        },
        {
            "rel": "data",
            "href": "/reporting-api/v2/reports/delivery/ivm/video-urls/data",
            "allow": [
                "POST"
            ]
        }
    ]
}