Reporting API Reference
Getting started
To get more insights before diving into the Reporting API reference, please read the Getting started article to see how to authenticate, interact with the API and its limitations.
Introduction
The Reporting API allows you to monitor the performance of your videos with flexibility and granularity. It accepts metrics – such as the number of views or the estimated earnings – that can be scaled down using dimensions and filters for more precise results.
| Metrics | Measurements related to activity |
| Dimensions | Organize metrics across common criteria |
| Filters | Scope down the result set |
| Product | Targets a specific product usage. On Dailymotion, data is collected and attributed against three different kinds of product usage: data generated on your content, on your embeds or on your claims. |
Metrics
| Metrics | Definitions |
|---|---|
VIEWS | Number of views |
TIME_WATCHED_SECONDS | Time watched in seconds |
VIEW_THROUGH_RATE | Video view through rate |
UPLOADS | Videos uploaded |
LIVE_VIEWERS | Live viewers |
LIVE_TIME_WATCHED_SECONDS | Live time watched |
ESTIMATED_EARNINGS_USD | Estimated earnings in USD |
ESTIMATED_EARNINGS_EUR | Estimated earnings in EUR |
TOTAL_INVENTORY | Total ad opportunities generated by your content or your embeds |
NO_ADS | Ad opportunities identified to be not eligible for monetization |
NO_AD_RATE | Share of ad opportunities not eligible for monetization No ad rate = No ads / Total inventory |
SELLABLE_INVENTORY | Ad opportunities available for monetization |
NB_IMPRESSION | Total number of ads displayed |
FILL_RATE | Share of sellable inventories filled with an ad impression Fill rate = Ad impressions / Sellable inventory |
NB_MISSED_IMPRESSION | Monetizable ad opportunities that were not filled with an ad impression. It includes ad errors, timeouts and nofills Missed impressions = Sellable inventory – impressions |
VIEWABILITY_SCORE | Share of ad impressions with high viewability Viewability score = Ad impressions with high viewability / Ad impressions |
Coming soon:GDPR_FULL_CONSENT_SCORE | Share of users who granted their full consent for the processing of their personal data GDPR full consent score = GDPR full consent / Ad impressions |
Coming soon:VTR_SCORE | Share of users who watched a full ad VTR score = Ad view completed / Ad impressions |
Dimensions
| Dimension | Definitions |
|---|---|
MONTH | Month |
DAY | Day |
HOUR | Hour |
MINUTE | Minute |
CHANNEL_SLUG | Channel owner’s channel URL Slug Note: value is case sensitive – make sure to input accurate lower and upper cases |
VIDEO_OWNER_CHANNEL_SLUG | Content owner’s channel URL Slug Note: value is case sensitive – make sure to input accurate lower and upper cases |
VIDEO_ID | Video ID |
VIDEO_TITLE | Title of the video |
MEDIA_TYPE | Type of video: LIVE or VIDEO |
VISITOR_DOMAIN_GROUP | Visitor domain |
VISITOR_SUBDOMAIN | Visitor subdomain |
VISITOR_PAGE_URL | Visitor page URL |
VISITOR_COUNTRY | Visitor country |
VISITOR_DEVICE_TYPE | Visitor device type |
MONETIZATION_TYPE | Monetization category: video or website |
INVENTORY_POSITION | Position of the ad opportunity. Usually one of the following – preroll, midroll, postroll, ivv |
OUTCOME | Breakdown of missed impression by category |
NOAD_REASON_READABLE | No ads grouped by why they were not available for monetization. Click here to learn more about no ad reason |
AD_ERROR_READABLE | Ad errors returned by our advertising system for the selected metric |
AD_ERROR_CODE | Ad error code returned by our advertising system for the selected metric |
BUYER | Potential and actual buyers of the inventory |
BUYER_TYPE | Type of buyer of the inventory. Usually either P1 or Dailymotion |
ACTION | Action defines how a view or inventory was generated by clarifying the stakeholders involved Example my content played on other properties shows that the ad inventory was generated because one of my content was being played on another account’s website or application |
AD_FORMAT | Type of ad being displayed. Usually one of the following: – instream: a video ad – display_preroll: a static image ad |
PLAYER_ID | ID(s) of the player(s) used to play your content. The ID(s) listed can be yours or from third parties. |
PLAYER_TITLE | Title(s) of the player(s) used to play your content. The title(s) listed can be yours or from third parties. |
PLAYLIST_ID | ID(s) of the playlist(s) used to play your content. The ID(s) listed can be yours or from third parties. |
PLAYLIST_TITLE | Title(s) of the playlist(s) used to play your content. The title(s) listed can be yours or from third parties. |
VIDEO_POSITION | Position of the video within a playlist |
CONTENT_TAG | Breakdown the data by each tag specified on content. Note that more than one tag can be added to a single content : when using this dimension the returned metrics (data) may overlap and cannot be summed up. Example: Video A has tags (Tag 1, Tag 2) and has accumulated 10 views on March 5, 2022 Generating a report for this date might result in the following: DAY, VIDEO TITLE, CONTENT_TAG, VIEWS2022-03-05, Video A, Tag 1, 102022-03-05, Video A, Tag 2, 10Since Video A is using both Tag 1 and Tag 2, the views column here cannot be summed as it would result in 20 views which is not the total number of views. |
CONTENT_TAG_LIST | Comma separated list of tags specified on content |
Filters
| Filters | Definitions | Type | Possible values |
|---|---|---|---|
channelSlug | Limits the result set to a specific channel | Variable values | N/A |
videoOwnerChannelSlug | Limits the result set to a specific video owner channel | Variable values | N/A |
mediaType | Limits the result set to a specific media type: LIVE or VIDEO | Fixed values | VIDEO, LIVE |
visitorDomainGroup | Limits the result set to a specific visitor domain group | Variable values | N/A |
monetizationType | Limits the monetization category to either Video Monetization or Website Monetization | Fixed values | Video monetization, Website monetization, claim |
Products
| Product | Description |
|---|---|
CONTENT | This is the Default value if product is not specified. Get data only for content that belongs to this Partner account |
EMBED | Get data only for embeds that belong to this Partner account |
CLAIM | Get data only for claims that belong to this Partner account Only accessible if you have ongoing claims |
ALL | Get data only for content, embeds and claims that belong to this Partner account |
Compatibility matrix
Not all metrics and dimensions can be combined in a single report. Refer to this table for guidance.
| Metrics | Supported dimensions | |
|---|---|---|
| Audience data | VIEWS, TIME_WATCHED_SECONDS, VIEW_THROUGH_RATE | MONTH, DAY, HOUR VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE, MEDIA_TYPE VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE ACTION PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION CONTENT_TAG, CONTENT_TAG_LIST |
| Account data | UPLOADS | MONTH, DAY VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE VISIBILITY |
| Live streaming data | LIVE_VIEWERS, LIVE_TIME_WATCHED_SECONDS | MONTH, DAY, HOUR, MINUTE VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_DEVICE_TYPE, PLAYER_ID, PLAYER_TITLE CONTENT_TAG, CONTENT_TAG_LIST |
| Revenue data | ESTIMATED_EARNINGS_USD, ESTIMATED_EARNINGS_EUR | MONTH, DAY CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE INVENTORY_POSITION ACTION PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION CONTENT_TAG, CONTENT_TAG_LIST |
| Ads data | TOTAL_INVENTORY, NO_ADS, NO_AD_RATE, SELLABLE_INVENTORY, FILL_RATE, NB_IMPRESSION, NB_MISSED_IMPRESSION, AD_ERRORS, NO_FILLS, TIMEOUTS, SELLABLE_INVENTORY, FILL_RATE, NB_IMPRESSION, NB_MISSED_IMPRESSION, AD_ERRORS, NO_FILLS, TIMEOUTS NB_MISSED_IMPRESSION | MONTH, DAY VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE, INVENTORY_POSITION ACTION BUYER OUTCOME, AD_ERROR_READABLE, AD_ERROR_CODE AD_FORMAT PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION CONTENT_TAG, CONTENT_TAG_LIST |
| Quality data | IVT_SCORE, VIEWABILITY_SCORE, Coming soon: VTR_SCORE, GDPR_FULL_CONSENT_SCORE | MONTH, DAY VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE PLAYER_SIZE_BUCKET PLAYER_ID, PLAYER_TITLE |
| Filters | VIEWS | TIME_WATCHED_SECONDS | IMPRESSIONS | ESTIMATED_EARNINGS_* |
|---|---|---|---|---|
| channelSlug | ✔ | |||
| videoOwnerChannelSlug | ✔ | ✔ | ✔ | |
| mediaType | ✔ | ✔ | ||
| visitorDomainGroup | ✔ | ✔ | ✔ | ✔ |
| monetizationType | ✔ |
Changelog
Coming soon
New metrics to monitor your monetization performance:
GDPR_FULL_CONSENT_SCOREVTR_SCORE
Check the compatibility matrix to use matching dimensions.
These metrics are already available in the Dailymotion Studio in Analytics > Insights where reports can be generated for deeper insights
2022-12-15
You can now track the performances of each tags available on your content via the Reporting API:
- 2 new dimensions have been added :
CONTENT_TAGandCONTENT_TAG_LIST - The compatibility matrix has been updated with the new dimensions
2022-07-25
You can now track Playlists and Players performances via the Reporting API:
- 4 new dimensions have been added: PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE
- The compatibility matrix has been updated with the new dimensions.
2022-03-16
- 1 metric has been deprecated: Monetization_type
- 3 new dimensions have been added: Buyer_type, Action, Ad_format
- The compatibily matrix has been updated with the new metrics and dimensions