Use this controller to retrieve statistic information for a given mediacontainer or aggregated for the customer.
Reference
MediaContainer Statistic
TBC
GET/v4/statistic
Returns all statistics for a given mediaContainerId
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| aggregatedBy | array | ✗ | TBA |
| endDate | string | ✗ | optional end date for statistic |
| field | string | ✗ | TBA allowed values: *countViewwatchTimecountDownloadcountPlaybrowser_familyreferer_domaincitycountryengagementfinishesidentifiermediaIdssubtitlewatchTimelogDayos |
| fields | array | ✗ | TBA |
| file | string | ✗ | TBA allowed values: xlsx-binaryxlsx-bufferxlsx-base64csv-stringcsv-base64 |
| identifier | string | ✗ | filter for identifier |
| limit | integer | ✗ | TBA |
| mediaContainerId | integer | ✗ | mediaContainer to get stats for |
| model | string | ✗ | Model to use, defaults to general allowed values: browsergeneralgeoidentifierreferer_domainoriginsource |
| order | string | ✗ | TBA allowed values: descasc |
| referer_domain | string | ✗ | filter for referer_domain |
| startDate | string | ✗ | start date for statistic |
Customer Statistic
Aggregated statistic for the logged in customer. This endpoint delivers information in regards to asset performance. Do not use this endpoint for consumption stats of quotas.
GET/v4/statistic/customer
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| endDate | string | ✗ | optional end date for statistic |
| startDate | string | ✗ | start date for statistic |
Response
| Field | Type | Description |
|---|---|---|
| endDate | string | optional end date for statistic |
| startDate | string | start date for statistic |
Customer Consumption Statistic
Delivers consumption statistic for storage, traffic, users and assets.
This call is new and delivers historical data for dates before 2023-12-10. Please note, that storage files differ for entries before that date, due to changes in the calculation. This value has not been and is not used for billing.
GET/v4/statistic/customer/consumption
Return consumption stats (storage, traffic, user, assets), relevant for billing
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| endDate | string | ✗ | optional end date for statistic |
| startDate | string | ✗ | start date for statistic |
Response
| Field | Type | Description |
|---|---|---|
| assets | array | Asset stats for the given time period |
| └ month | string | Month in format YYYY-MM |
| └ daysInPeriod | integer | Number of days in month |
| └ type | string | Asset type, e.g. image, video, mediahub… |
| └ cnt | number | Max number of files in the given period |
| endDate | string | optional end date for statistic |
| licensePeriod | object | Current license period for the customer |
| └ startDate | string | Start date of the license period |
| └ endDate | string | End date of the license period |
| startDate | string | start date for statistic |
| storage | object | Storage statistics |
| └ month | string | Month in format YYYY-MM |
| └ daysInPeriod | integer | Number of days in month |
| └ avgStorage | float | Average storage in the given period in bytes |
| └ maxStorage | integer | Maximum storage in the given period in bytes. The relevant value for calculation. |
| └ minStorage | integer | Minimum storage |
| └ avgFiles | float | Average number of files |
| └ avgStorage_human | string | Average storage in the given period in human readable format |
| └ maxStorage_human | string | Maximum storage in the given period in human readable format. The relevant value for calculation. |
| └ minStorage_human | string | Minimum storage in human readable format |
| └ contractLimit | integer | Contract limit in this month in bytes |
| └ contractLimit_human | string | Contract limit for this month in human readable format |
| └ currentDay | string | Current day in format YYYY-MM-DD. Only shown in the current month |
| └ currentStorage | integer | Current storage in bytes for the current day |
| └ currentStorage_human | string | Current storage in human readable format for the current day |
| └ currentFiles | integer | Current number of files for the current day |
| traffic | object | Traffic statistics for the selected license period |
| └ month | string | Month in format YYYY-MM |
| └ daysInPeriod | integer | Number of days in month |
| └ traffic | integer | Total Traffic in bytes in this month |
| └ requests | integer | Total number of requests in this month |
| └ traffic_human | string | Total Traffic in human readable format in the given period |
| └ aggregatedTraffic | integer | Aggregated Traffic in bytes from the start of the license period until the end of this month |
| └ aggregatedTraffic_human | string | Aggregated Traffic in human readable format from the start of the license period until the end of this month |
| └ contractLimit | integer | contract limit in this month in bytes |
| └ contractLimit_human | string | Contract limit for this month in human readable format |
| └ monthlyContractLimit | integer | Evenly distributed monthly contract limit in bytes for this month. This has informational character only as traffic is calculated per license year. |
| └ monthlyContractLimit_human | string | Evenly distributed monthly contract limit in human readable format for this month. This has informational character only as traffic is calculated per license year. |
| users | array | User stats for the given time period |
| └ month | string | Month in format YYYY-MM |
| └ daysInPeriod | integer | Number of days in month |
| └ clientId | string | Client ID |
| └ isAdmin | number | Admin status allowed values: 01 |
| └ cnt | number | Max number of users for the admin status and clientId in the given period |