Table of content

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.

MetricsMeasurements related to activity
DimensionsOrganize metrics across common criteria
FiltersScope down the result set
ProductTargets 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.
Note:

dimensions, metrics, filters and products are case sensitive and must be used as shown in the tables.


Metrics

MetricsDefinitions
VIEWSNumber of views
TIME_WATCHED_SECONDSTime watched in seconds
VIEW_THROUGH_RATEVideo view through rate
UPLOADSVideos uploaded
LIVE_VIEWERSLive viewers
LIVE_TIME_WATCHED_SECONDSLive time watched
ESTIMATED_EARNINGS_USDEstimated earnings in USD
ESTIMATED_EARNINGS_EUREstimated earnings in EUR
TOTAL_INVENTORYTotal ad opportunities generated by your content or your embeds
NO_ADSAd opportunities identified to be not eligible for monetization
NO_AD_RATEShare of ad opportunities not eligible for monetization

No ad rate = No ads / Total inventory
SELLABLE_INVENTORYAd opportunities available for monetization
NB_IMPRESSIONTotal number of ads displayed
FILL_RATEShare of sellable inventories filled with an ad impression

Fill rate = Ad impressions / Sellable inventory
NB_MISSED_IMPRESSIONMonetizable ad opportunities that were not filled with an ad impression. It includes ad errors, timeouts and nofills

Missed impressions = Sellable inventory – impressions
VIEWABILITY_SCOREShare of ad impressions with high viewability

Viewability score = Ad impressions with high viewability / Ad impressions
GDPR_FULL_CONSENT_SCOREShare of users who granted their full consent for the processing of their personal data

GDPR full consent score = GDPR full consent / Ad impressions
VTR_SCOREShare of users who watched a full ad

VTR score = Ad view completed / Ad impressions

Dimensions

DimensionDefinitions
MONTHMonth
DAYDay
HOURHour
MINUTEMinute
CHANNEL_SLUGChannel owner’s channel URL Slug
Note: value is case sensitive – make sure to input accurate lower and upper cases
VIDEO_OWNER_CHANNEL_SLUGContent owner’s channel URL Slug
Note: value is case sensitive – make sure to input accurate lower and upper cases
VIDEO_IDVideo ID
VIDEO_TITLETitle of the video
MEDIA_TYPEType of video: LIVE or VIDEO
VISITOR_DOMAIN_GROUPVisitor domain
VISITOR_SUBDOMAINVisitor subdomain
VISITOR_PAGE_URLVisitor page URL
VISITOR_COUNTRYVisitor country
VISITOR_DEVICE_TYPEVisitor device type
MONETIZATION_TYPEMonetization category: video or website
INVENTORY_POSITIONPosition of the ad opportunity. Usually one of the following – preroll, midroll, postroll, ivv
OUTCOMEBreakdown of missed impression by category
NOAD_REASON_READABLENo ads grouped by why they were not available for monetization. 
Click here to learn more about no ad reason
AD_ERROR_READABLEAd errors returned by our advertising system for the selected metric
AD_ERROR_CODEAd error code returned by our advertising system for the selected metric
BUYERPotential and actual buyers of the inventory
BUYER_TYPEType of buyer of the inventory. Usually either P1 or Dailymotion
ACTIONAction 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_FORMATType of ad being displayed. Usually one of the following:
– instream: a video ad 
– display_preroll: a static image ad
PLAYER_IDID(s) of the player(s) used to play your content.
The ID(s) listed can be yours or from third parties.
PLAYER_TITLETitle(s) of the player(s) used to play your content.
The title(s) listed can be yours or from third parties.
PLAYLIST_IDID(s) of the playlist(s) used to play your content.
The ID(s) listed can be yours or from third parties.
PLAYLIST_TITLETitle(s) of the playlist(s) used to play your content.
The title(s) listed can be yours or from third parties.
VIDEO_POSITIONPosition of the video within a playlist
CONTENT_TAGBreakdown 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, VIEWS
2022-03-05, Video A, Tag 1, 10
2022-03-05, Video A, Tag 2, 10
 
Since 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_LISTComma separated list of tags specified on content

Filters

FiltersDefinitionsTypePossible values
channelSlugLimits the result set to a specific channelVariable valuesN/A
videoOwnerChannelSlugLimits the result set to a specific video owner channelVariable valuesN/A
mediaTypeLimits the result set to a specific media type: LIVE or VIDEOFixed valuesVIDEOLIVE
visitorDomainGroupLimits the result set to a specific visitor domain groupVariable valuesN/A
monetizationTypeLimits the monetization category to either Video Monetization or Website MonetizationFixed valuesVideo monetizationWebsite monetizationclaim

Products

ProductDescription
CONTENTThis is the Default value if product is not specified.
Get data only for content that belongs to this Partner account
EMBEDGet data only for embeds that belong to this Partner account
CLAIMGet data only for claims that belong to this Partner account
Only accessible if you have ongoing claims
ALLGet 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.

MetricsSupported dimensions
Audience dataVIEWS
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 dataUPLOADSMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISIBILITY
Live streaming dataLIVE_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 dataESTIMATED_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, AD_FORMAT
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
Ads dataTOTAL_INVENTORYMONTH, 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
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
NO_ADSMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
INVENTORY_POSITION
NOAD_REASON_READABLE
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
NO_AD_RATEMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
INVENTORY_POSITION
NOAD_REASON_READABLE
BUYER
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
SELLABLE_INVENTORY
FILL_RATE
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
BUYER, BUYER_TYPE
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
NB_IMPRESSIONMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
INVENTORY_POSITION
BUYER, BUYER_TYPE
AD_FORMAT
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
NB_MISSED_IMPRESSIONMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
INVENTORY_POSITION
BUYER, BUYER_TYPE
OUTCOME, AD_ERROR_READABLE, AD_ERROR_CODE
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
AD_ERRORSMONTH, DAY
VIDEO_OWNER_CHANNEL_SLUG, VIDEO_ID, VIDEO_TITLE
VISITOR_COUNTRY, VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
INVENTORY_POSITION
BUYER, BUYER_TYPE
AD_ERROR_READABLE, AD_ERROR_CODE
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
NO_FILLS
TIMEOUTS
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
BUYER
ACTION
PLAYER_ID, PLAYER_TITLE, PLAYLIST_ID, PLAYLIST_TITLE, VIDEO_POSITION
CONTENT_TAG, CONTENT_TAG_LIST
Quality dataVIEWABILITY_SCORE
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
IVT_SCOREMONTH, DAY
VISITOR_DOMAIN_GROUP, VISITOR_SUBDOMAIN, VISITOR_PAGE_URL, VISITOR_DEVICE_TYPE
PLAYER_ID, PLAYER_TITLE

FiltersVIEWSTIME_WATCHED_SECONDSIMPRESSIONSESTIMATED_EARNINGS_*
channelSlug
videoOwnerChannelSlug
mediaType
visitorDomainGroup
monetizationType

Changelog

2024-05-15

New metrics to monitor your monetization performance:

  • GDPR_FULL_CONSENT_SCORE
  • VTR_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:


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