List of fields to return for requests in the video object.
Fields | Description |
|---|---|
| Returns the custom target value for a given video. |
| True if the owner blocked instream ads on this video. |
| Whether AI chapter generation is required for the video or not. |
| List of language codes requested for AI-generated subtitles. |
| True if this video can be embedded outside of Dailymotion. |
| True if this video can be added to playlists. |
| Aspect ratio of this video (i.e.: |
| Current live stream audience. |
| Total live stream audience since stream creation. |
| Audience meter URL to be used for this video. |
| List of available stream formats for this video. |
| Category of the video. |
| Video file hash. |
| List of countries where this video is blocked by the claimer. |
| List of countries where this video is monetized by the claimer. |
| List of countries where this video is tracked by the claimer. |
| Content provider name. |
| Content provider identifier. |
| Country of this video (declarative, may be null). Allowed values are ISO 3166-1 alpha-2 country codes. |
| Date and time when this video was uploaded. |
| List of customizable values (maximum of 3 values). |
| Comprehensive description of this video. |
| Duration of this video in seconds. |
| HTML embedding code. Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about |
| URL to embed this video. |
| When this video |
| End date and time of this live stream. |
| Date and time after which this video will be made private. |
| By default, videos reaching their |
| By default, videos are deleted (after a grace period) when their |
| True if this video is explicit. - Warning: It’s not possible to remove this flag once set. |
| URL of the filmstrip sprite of this video. 100 images arranged in a 10×10 grid. Not available for short videos. |
| URL of this video’s first frame image (60px height). |
| URL of this video’s first frame image (120px height). |
| URL of this video’s first frame image (180px height). |
| URL of this video’s first frame image (240px height). |
| URL of this video’s first frame image (360px height). |
| URL of this video’s first frame image (480px height). |
| URL of this video’s first frame image (720px height). |
| URL of this video’s first frame image (1080px height). |
| List of countries where this video is or isn’t accessible. |
| Geolocalization for this video. Result is an array with the longitude and latitude using point notation. |
| List of hashtags attached to this video. |
| Height of this video from the source (px). |
| Unique object identifier (unique among all videos) |
| True if this video is "Created for Kids" (intends to target an audience under the age of 16). |
| Graph type of this object |
| Language of this video. This value is declarative and corresponds to the user-declared spoken language of the video. |
| Date and time when this video was liked by the user. |
| Total amount of times this video has been liked. |
| Estimated time for the end of the commercial ad break. |
| Launches a given number of ad breaks for this live stream. |
| Returns the number of remaining ad break for this live stream. |
| Date and time when this live stream went on-air for the last time. |
| Live stream information: audio bitrate (b/s). |
| True if this live stream is automatically recorded. |
| List of available live ingests. |
| URL to publish the live source stream on using SRT. The current logged-in user needs to own this video to retrieve this field. |
| URL to publish the live source stream on using RTMP. The current logged in user need to own this video in order to retrieve this field. |
| A one time usage list of URLs to be called in order log a view on this video made on a third party site (i.e.: embed player). See the |
| A one time usage URL to log a view on this video. This URL expires after a short period of time, thus you should request it at the last moment. |
| A one time usage list of URLs that will be called in order to log video view events. |
| Media type of this content. |
| Stream mode. |
| True if this live stream is broadcasting and watchable in the player. |
| Owner of this video. You can retrieve sub-fields of this |
| True if the video is owned by a partner. |
| True if this video is password-protected. |
| A unique video picked by the owner, displayed when video’s playback ends. |
| An array of video picked by the owner, displayed when video’s playback ends. |
| URL of this video’s video preview. |
| URL of this video’s video preview. |
| URL of this video’s video preview. |
| True if this video is private. |
| The private video id. |
| Date and time after which this video will be made publicly available. |
| Keep this video private when its |
| True if this video is published (may still be waiting for encoding, see the |
| When this video |
| Date and time when the video record was stopped. |
| Date and time when the video record started. |
| Current state of the recording process of this video. |
| Recurrence of this live stream. |
| URL of the image-based seeker resource of this video. internal resource format is proprietary. Not available for short videos. |
| The International Standard Recording Code of the soundtrack associated to this video. |
| Soundtrack popularity. |
| URL of the sprite of this video. Width: 320px. |
| URL of the sprite of this video. |
| Start date and time of this live stream. |
| Status of this video. A video requires the |
| Whether the video stream has been altered by AI. |
| URL of this audio stream. |
| URL of the Full HD video stream (1080p, ~6.25 Mbps). |
| URL of the high definition video stream (720p, ~2.17 Mbps). |
| URL of the high quality WVGA video stream (480p, ~845 kbps). |
| URL of the very low quality/low bandwidth mobile video stream (144p, ~60 kbps). |
| URL of the very low quality/high bandwidth mobile video stream (144p, ~106 kbps). |
| URL of the low quality QVGA Mobile 3G video stream (240p, ~260 kbps). ` |
| URL of the Quad HD video stream (1440p, ~10.4 Mbps). |
| URL of the Ultra HD 4K video stream (2160p, ~16.5 Mbps). |
| URL of the medium quality video stream (384p, ~465 kbps). |
| URL of the adaptative bitrate manifest using the Apple HTTP Live Streaming protocol. |
| URL of this live stream using the HTTP Live Streaming protocol. |
| URL of this live stream using the RTMP protocol. |
| URL of this live stream using the Smooth Streaming protocol. |
| URL of this video source. |
| True if this video is produced by the Dailymotion Studio. |
| List of tags attached to this video. |
| URL of this video’s thumbnail image. Height: 60px |
| URL of this video’s thumbnail image. Height: 62px |
| URL of this video’s thumbnail image. Height: 120px |
| URL of this video’s thumbnail image. Height: 180px |
| URL of this video’s thumbnail image. Height: 240px |
| URL of this video’s thumbnail image. Height: 360px |
| URL of this video’s thumbnail image. Height: 480px |
| URL of this video’s thumbnail image. Height: 720px |
| URL of this video’s thumbnail image. Height: 1080px |
| URL of this video’s raw thumbnail (full size respecting ratio). |
| Tiny URL of this video. |
| Title of this video. |
| Date and time when this video was last updated. |
| Date and time when this video was originally uploaded. |
| URL of this video on Dailymotion. |
| True if the video is owned by a verified partner. |
| Total number of views on this video in the last 24 sliding hours. |
| Total number of views on this video in the last sliding hour. |
| Total number of views on this video in the last 30 sliding days. |
| Total number of views on this video in the last 7 sliding days. |
| Total amount of views on this video since its publication. |
| Width of this video from the source (px). |
advertising_custom_target
advertising_custom_targetReturns the custom target value for a given video. This value is sent to Liverail as an LR_DM_ADPARAM param. This can be used for targeting in liverail.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | string example | Private,can-manage-ads scope | Private, can-manage-ads scope |
advertising_instream_blocked
advertising_instream_blockedTrue if the owner blocked instream ads on this video.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | Private, manage_videos scope |
ai_chapter_generation_required
ai_chapter_generation_requiredWhether AI chapter generation is required for the video or not.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | true | Public | Private, can be written by the owner of the object with manage_videos scope |
ai_subtitle_languages
ai_subtitle_languagesList of language codes requested for AI-generated subtitles.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | en, fr, es | Public | Private, can be written by the owner of the object with manage_videos scope |
allow_embed
allow_embedLimit the result set to private playlists.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Private,can-manage-ads scope | Private, manage_videos scope |
allowed_in_playlists
allowed_in_playlistsLimit the result set to private playlists.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | Private, can be written by the owner of the object |
aspect_ratio
aspect_ratioAspect ratio of this video (i.e.: 1.33333 for 4/3, 1.77777 for 16/9…).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 1.7777777 | Public | N/A |
audience
audienceCurrent live stream audience. null if the audience shouldn’t be taken into consideration.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 450 | Public | N/A |
audience_total
audience_totalTotal live stream audience since stream creation. null if the audience shouldn’t be taken into account.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 2457 | Public | N/A |
audience_url
audience_urlAudience meter URL to be used for this video. null if the audience shouldn’t be taken into account.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://195.8.215.201/vxqjkf1 | Public | Private, can-read-live-audience-url scope |
available_formats
available_formatsList of available stream formats for this video.
Allowed values: l1 l2 ld sd hq hd720 hd1080 uhd1440 or uhd2160
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | ld, sd, hq, hd720, hd1080 | Public | Private, can be written by the owner of the object |
channel
channelChannel of this video. You can retrieve sub-fields of this channel object using the dot-notation (e.g.: channel.id).
Allowed values: animals creation auto school people fun videogames tech kids lifestyle shortfilms music news sport tv travel webcam
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | news | Public | Private, can be written by the owner of the object |
checksum
checksumVideo file hash.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | 64f771f2fccff6cef46f2f34112a67ff8e940103 | Public | Private, can be written by the owner of the object |
claim_rule_blocked_countries
claim_rule_blocked_countriesList of countries where this video is blocked by the claimer. A list of country codes (ISO 3166-1 alpha-2) e.g.: ["FR", "US"] will block this video in France and US.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | FR, US | Private, manage_claim_rules scope and can-read-claim-rules role are required | N/A |
claim_rule_monetized_countries
claim_rule_monetized_countriesList of countries where this video is monetized by the claimer. A list of country codes (ISO 3166-1 alpha-2) e.g.: ["FR", "US"] will monetize this video in France and US.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | FR, US | Private, manage_claim_rules scope and can-read-claim-rules role are required | N/A |
claim_rule_tracked_countries
claim_rule_tracked_countriesList of countries where this video is tracked by the claimer. A list of country codes (ISO 3166-1 alpha-2) e.g.: ["FR", "US"] will track this video in France and US but it won’t be blocked nor monetized by the claimer.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | FR, US | Private, manage_claim_rules scope and can-read-claim-rules role are required | N/A |
content_provider
content_providerContent provider name.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | cbs | Can't be read, only used for object creation | Private, can-manage-video-provider or content-partner role is required |
content_provider_id
content_provider_idContent provider identifier.
Min length: 1 / Max length: 255
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | UAMM20701001 | Public, can-manage-video-provider, content-partner, can-read-video-provider roles are required | Private, content-partner, can-manage-video-provider roles are required |
country
countryCountry of this video (declarative, may be null). Allowed values are ISO 3166-1 alpha-2 country codes.
min length: 1 / max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | us | Public | Private, can be written by the owner of the object |
created_time
created_timeDate and time when this video was uploaded.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
custom_classification
custom_classificationList of customizable values (maximum of 3 values)
Min length: 1 / Max length: 100
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | ref1, ref2, ref3 | Public | Private, manage_videos scope |
description
descriptionComprehensive description of this video. Maximum length is set to 3000 (5000 for partners).
Min length: 1 / Max length: 3000 (5000 for Pro)
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | This is a sample description for my video. | Public | Private, can be written by the owner of the object |
duration
durationDuration of this video in seconds.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 423 | Public | N/A |
embed_html
embed_htmlHTML embedding code.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | <iframe frameborder="0" src="https://geo.dailymotion.com/player/xc394.html?video=x8mubmn" width="480" height="270" | Public | N/A |
Use the context parameter to specify a Player ID, to use custom Player configuration and ensure optimized monetization.
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
Context | Description | Required | Read | Write |
|---|---|---|---|---|
player | Use a Player ID. Example: | No | Yes | N/A |
embed_url
embed_urlURL to embed this video.
Use the context parameter to specify a Player ID, to use custom Player configuration and ensure optimized monetization.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | Value | Public | N/A |
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
Context | Description | Required | Read | Write |
|---|---|---|---|---|
player | Use a Player ID. Example: | No | Yes | N/A |
encoding_progress
encoding_progressWhen this video status field is set to processing, this parameter indicates a number between 0 and 100 corresponding to the percentage of encoding already completed. When this value reaches 100, it’s possible for the owner to play his video. For other statuses this parameter returns -1.
See also publishing_progress.
Min length: -1 / Max length: 100
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 22 | Public | N/A |
end_time
end_timeEnd date and time of this live stream.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1404129540 | Public | Private, can be written by the owner of the object |
expiry_date
expiry_dateDate and time after which this video will be made private.
Beware: if the video was originally defined as private, setting this value will automatically make it public between its publish_date and expiry_date.
This setting only affects the visibility of the video, it will still be available to anyone who knows how to access the video’s private URL even after this date. Omitting this value while setting a past publish_date never expires the video. Set to null (recommended) or a date after Jan 19th 2038 to reset this parameter.
Note : Only verified partners are allowed to manage video availability and expiration dates.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Private, manage_videos scope required | Private, manage_videos scope required |
expiry_date_availability
expiry_date_availabilityBy default, videos reaching their expiry_date are still available to anyone who knows how to access their private URL. Set this to false to disable this behavior.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Private, can-manage-video-availability role required | Private, can-manage-video-availability role required |
expiry_date_deletion
expiry_date_deletionBy default, videos are deleted (after a grace period) when their expiry_date is reached. Set this to false to disable this behavior.
Note : Only verified partners are allowed to manage video availability and expiration dates.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Private, manage_videos scope required | Private, manage_videos scope required |
explicit
explicitTrue if this video is explicit. Warning: It’s not possible to remove this flag once set.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | Private, can be written by the owner of the object |
filmstrip_60_url
filmstrip_60_urlURL of the filmstrip sprite of this video. 100 images arranged in a 10×10 grid. Not available for short videos.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://static2.dmcdn.net/static/video/184/210/46012481:jpeg_preview_contact.jpg?20120608161743 | Public | N/A |
first_frame_60_url
first_frame_60_urlURL of this video’s first_frame image (60px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/F83Oh/x60-sjB.jpg | Public | N/A |
first_frame_120_url
first_frame_120_urlURL of this video’s first_frame image (120px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x120-Zfs.jpg | Public | N/A |
first_frame_180_url
first_frame_180_urlURL of this video’s first_frame image (180px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x180-o-x.jpg | Public | N/A |
first_frame_240_url
first_frame_240_urlURL of this video’s first_frame image (240px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x240-tGY.jpg | Public | N/A |
first_frame_360_url
first_frame_360_urlURL of this video’s first_frame image (360px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x360-KuJ.jpg | Public | N/A |
first_frame_480_url
first_frame_480_urlURL of this video’s first_frame image (480px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x480-hw4.jpg | Public | N/A |
first_frame_720_url
first_frame_720_urlURL of this video’s first_frame image (720px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x720-Ec7.jpg | Public | N/A |
first_frame_1080_url
first_frame_1080_urlURL of this video’s first_frame image (1080px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x1080-Ec7.jpg | Public | N/A |
geoblocking
geoblockingList of countries where this video is or isn’t accessible.
A list of country codes (ISO 3166-1 alpha-2) starting with the deny or allow (default) keyword to define if this is a block or an allowlist, e.g.: both allow, fr, us, it and fr, us, it will allow this video to be accessed in France, US and Italy and deny all other countries.
On the other hand, deny, us, fr will deny access to this video in the US and France and allow it everywhere else.
An empty list or simply allow (the default) will revert the behavior to allow from everywhere.
The geoblocking field must be sent as a comma-separated string, but is returned as an array in API responses
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | allow, fr, us, it | Public | Private, manage_videos scope required |
geoloc
geolocGeolocalization for this video. Result is an array with the longitude and latitude using point notation. Longitude range is from -180.0 (West) to 180.0 (East). Latitude range is from -90.0 (South) to 90.0 (North).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | -122.40061283112, 37.782112059896 | Public | Private, can be written by the owner of the object |
hashtags
hashtagsList of hashtags attached to this video.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | # hello, #world | Public | Private, can be written by the owner of the object |
height
heightHeight of this video from the source (px).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 240 | Public | N/A |
id
idUnique object identifier (unique among all videos)
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | xp1su4e | Public | N/A |
is_created_for_kids
is_created_for_kidsTrue if this video is "Created for Kids" (intends to target an audience under the age of 16).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | N/A |
item_type
item_typeGraph type of this object
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | video | Public | N/A |
language
languageLanguage of this video. This value is declarative and corresponds to the user-declared spoken language of the video. Allowed values are ISO-639-3 alpha-2 and alpha-3 language codes.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | en | Public | Private, can be written by the owner of the object |
liked_at
liked_atDate and time when this video was liked by the user.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
likes_total
likes_totalTotal amount of times this video has been liked.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 102 | Public | N/A |
live_ad_break_end_time
live_ad_break_end_timeEstimated time for the end of the commercial ad break.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Private, manage_videos scope required | N/A |
live_ad_break_launch
live_ad_break_launchLaunches a given number of ad breaks for this live stream.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 1 | N/A | Private, manage_videos scope required |
live_ad_break_remaining
live_ad_break_remainingReturns the number of remaining ad break for this live stream.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 2 | Private, manage_videos scope required | N/A |
live_airing_time
live_airing_timeDate and time when this live stream went on-air for the last time
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
live_audio_bitrate
live_audio_bitrateLive stream information: audio bitrate (b/s)
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 125928 | Public | N/A |
live_auto_record
live_auto_recordTrue if this live stream is automatically recorded.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | Private, manage_videos scope required |
live_backup_video
live_backup_videoThe live backup video, it is get/set as an xid, but is stored as an integer ID in DB
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | xid | Public | Private, can be written by the owner of the object |
live_ingests
live_ingestsList of available live ingests.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| dict | {"Default":"publish.dailymotion.com" | Public | N/A |
live_publish_srt_url
live_publish_srt_urlURL to publish the live source stream on using SRT. The current logged-in user needs to own this video to retrieve this field.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | srt://publish-srt.dailymotion.com:19213/?streamid=publish:publish-dm/x26m1j4?auth=... | Public | N/ |
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
| Context | Description | Required | Read | Write |
|---|---|---|---|---|
| refresh | Pass this context value (refresh=true) if you need to refresh the stream key for the publish URL. | No | Yes | No |
live_publish_url
live_publish_urlURL to publish the live source stream on. The current logged in user need to own this video in order to retrieve this field.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | rtmp\://publish.dailymotion.com/publish-dm/x26m1j4?auth=... | Public | N/A |
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
| Context | Description | Required | Read | Write |
|---|---|---|---|---|
| refresh | Pass this context value (refresh=true) if you need to refresh the stream key for the publish URL. | No | Yes | No |
log_external_view_urls
log_external_view_urlsA one time usage list of URLs to be called in order log a view on this video made on a third party site (i.e.: embed player). See the log_view_urls field for format.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| dict | {"viewlog":"https:\/\/logger.dm.com\/..."} | Private, can-log-video-views role required | N/A |
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
Context | Description | Required | Read | Write |
|---|---|---|---|---|
autoplay | Whether the video autoplays or not. | No | Yes | No |
curator | Login or id of a user that acts as curator. | No | Yes | No |
client_embedder | Value of the app query parameter passed by the client. | No | Yes | No |
embedder_url | URL of the page that embeds the video. | No | Yes | No |
referer_url | URL of the page that led the user to the current page. | No | Yes | No |
related | Array that describes the related settings used at the time the API call is made:
| No | Yes | No |
sid | Session id of the current reader. | No | Yes | No |
tracking_urls | Array of custom tracking URLs that respect the | No | Yes | No |
log_view_url
log_view_urlA one time usage URL to log a view on this video. This URL expires after a short period of time, thus you should request it at the last moment.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/logger/video/access/x26m1j4?session_id=)... | Private, can-log-video-views role required | N/A |
Reading and/or editing this field requires some contextual information. Please refer to the API global parameters list for more information about context.
| Context | Description | Required | Read | Write |
|---|---|---|---|---|
| embedder_url | URL of the page that embeds the video. | No | Yes | No |
| referer_url | URL of the page that led the user to the current page. | No | Yes | No |
log_view_urls (Incomplete)
log_view_urls (Incomplete)A one time usage list of URLs that will be called in order to log video view events.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| dict | {"viewlog":"https:\/\/logger.dm.com\/..."} | Private, can-log-video-views role required | N/A |
media_type
media_typeMedia type of this content.
allowed values: audio or video
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | video | Public | N/A |
mode
modeStream mode.
allowed values: vod or live
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | vod | Public | N/A |
onair
onairTrue if this live stream is broadcasting and watchable in the player.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | N/A |
owner
ownerOwner of this video. You can retrieve sub-fields of this user object using the dot-notation (e.g.: owner.id).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | xw739y0 | Public | N/A |
partner
partnerTrue if the video is owned by a partner.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | N/A |
password
passwordIf a video is protected by a password, this field contains the password (deprecated, as it now only returns NULL).
When setting a value on this field, the video visibility changes to "password protected". Setting it to NULL removes the password protection: the visibility is changed to "public".
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | hdI76FGhwo3n | Public | Private, manage_videos scope required |
password_protected
password_protectedTrue if this video is password-protected.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | true | Public | N/A |
player_next_video
player_next_videoA unique video picked by the owner, displayed when video’s playback ends. You can retrieve sub-fields of this video object using the dot-notation (e.g.: player_next_video.id).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | xw739y0 | Public | Private, manage_videos scope required |
player_next_videos
player_next_videosAn array of video picked by the owner, displayed when video’s playback ends.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | x1234, x1234 | Public | N/A |
preview_240p_url
preview_240p_urlURL of this video’s video preview in 240p.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-320x240/video/x26m1j4.pmp4?sec=... | Public | N/A |
preview_360p_url
preview_360p_urlURL of this video’s video preview in 360p.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | https://www.dailymotion.com/cdn/H264-512x384/video/x26m1j4.pmp4?sec= | Public | N/A |
preview_480p_url
preview_480p_urlURL of this video’s video preview in 480p.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | https://www.dailymotion.com/cdn/H264-848x480/video/x26m1j4.pmp4?sec=... | Public | N/A |
private
privateTrue if this video is private.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | true | Public | Private, can be written by the owner of the object |
private_id
private_idThe private video id.
Null if the authentificated user is not the owner of this video.
Although successive calls will generate different ids, a private id generated for a given video will always be valid. Beware that if the video is private and you disclose this private id, your video is no longer private.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | k1KqUqDdmllgej374a2 | Public | N/A |
publish_date
publish_dateDate and time after which this video will be made publicly available.
Beware: if the video was originally defined as private, setting this value will automatically make it public after the publish_date. This setting only affects the visibility of the video, it will still be available to anyone who knows how to access the video’s private URL even before this date.
Omitting this value while setting a future expiry_date immediately publishes the video.
Set to null (recommended) or a date before Jan 1st 1990 to reset this parameter.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Private, manage_videos scope required | Private, manage_videos scope required |
publish_date_keep_private
publish_date_keep_privateKeep this video private when its publication_date is reached.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | true | Private, can-manage-video-availability role required | Private, can-manage-video-availability role required |
published
publishedTrue if this video is published (may still be waiting for encoding, see the status field for more information).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | Private, can be written by the owner of the object |
publishing_progress
publishing_progressWhen this video status field is set to processing, this parameter indicates a number between 0 and 100 corresponding to the percentage of progress from the status waiting to ready.
Unlike encoding_progress that can reach 100 well before the switch from processing to ready, this value will not.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 22 | Public | N/A |
record_end_time
record_end_timeDate and time when the video record was stopped.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
record_start_time
record_start_timeDate and time when the video record started.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
record_status
record_statusCurrent state of the recording process of this video.
starting: Recording video is going to startstarted: Recording video is in progressstopping: Recording video is going to stopstopped: Recording video is stopped
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | started | Public | Private, manage_videos scope required |
recurrence
recurrenceRecurrence of this live stream.
Allowed values: once daily weekly
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | Value | Public | N/A |
seeker_url
seeker_urlURL of the image-based seeker resource of this video. internal resource format is proprietary. Not available for short videos.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | https://static2.dmcdn.net/static/video/184/210/46012481:jpeg_preview_seeker.jpg?20120608161743 | Public | N/A |
soundtrack_isrc
soundtrack_isrcThe International Standard Recording Code of the soundtrack associated to this video.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | FR-6V8-21-83311 | Public | Private, manage_videos scope required |
soundtrack_popularity
soundtrack_popularitySoundtrack popularity.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 100 | Public | Private, manage_videos scope required |
sprite_320x_url
sprite_320x_urlURL of the sprite of this video, width:320px
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | http://www.example.org/ | Public | N/A |
sprite_url
sprite_urlURL of the sprite of this video.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | http://www.example.org/ | Public | N/A |
start_time
start_timeStart date and time of this live stream.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
status
statusStatus of this video. A video requires the published status to be set to true to be watchable.
Allowed values: waiting processing ready published deleted encoding_error
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | processing | Public | N/A |
stream_altered_with_ai
stream_altered_with_aiWhether the video stream has been altered by AI
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | true | Public | Private, can be written by the owner of the object |
stream_audio_url
stream_audio_urlURL of this audio stream.
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited.
The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/mp4_null_aac/video/x26m1j4.mp4?auth=... | Public | N/A |
stream_h264_hd1080_url
stream_h264_hd1080_urlURL of the Full HD video stream (1080p, ~6.25 Mbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-1920x1080/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_hd_url
stream_h264_hd_urlURL of the high definition video stream (720p, ~2.17 Mbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.Description
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://wwwhttps//www.dailymotion.com/cdn/H264-1280x720/video/x26m1j4.mp4?auth=...dailymotion.com/cdn/H264-1920x1080/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_hq_url
stream_h264_hq_urlURL of the high quality WVGA video stream (480p, ~845 kbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-848x480/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_l1_url
stream_h264_l1_urlURL of the very low quality/low bandwidth mobile video stream (144p, ~60 kbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-176x144-1/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_l2_url
stream_h264_l2_urlURL of the very low quality/high bandwidth mobile video stream (144p, ~106 kbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-176x144-2/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_ld_url
stream_h264_ld_urlURL of the low quality QVGA Mobile 3G video stream (240p, ~260 kbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-320x240/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_qhd_url
stream_h264_qhd_urlURL of the Quad HD video stream (1440p, ~10.4 Mbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-2560x1440/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_uhd_url
stream_h264_uhd_urlURL of the Ultra HD 4K video stream (2160p, ~16.5 Mbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-3840x2160/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_h264_url
stream_h264_urlURL of the medium quality video stream (384p, ~465 kbps).
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/H264-512x384/video/x26m1j4.mp4?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_hls_url
stream_hls_urlURL of the adaptative bitrate manifest using the Apple HTTP Live Streaming protocol.
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/manifest/video/x26m1j4.m3u8?auth=... | Private, can-read-my-video-streams role required | N/A |
stream_live_hls_url
stream_live_hls_urlURL of this live stream using the HTTP Live Streaming protocol.
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/live/video/x26m1j4?protocol=hls&auth=... | Private, can-read-my-video-streams role required | N/A |
stream_live_rtmp_url
stream_live_rtmp_urlURL of this live stream using the RTMP protocol.
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/live/video/x26m1j4?protocol=rtmp&auth=... | Private, can-read-my-video-streams role required | N/A |
stream_live_smooth_url
stream_live_smooth_urlURL of this live stream using the Smooth Streaming protocol.
Without an access token this field contains null, the Dailymotion user associated with the access token must be the owner of the video.
This field is rate limited. The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/live/video/x26m1j4?protocol=smooth&auth=... | Private, can-read-my-video-streams role required | N/A |
stream_source_url
stream_source_urlURL of this video source.
Without an access token this field contains null, the dailymotion user associated with the access token must be the owner of the video.
This field returns null a few days after the video upload.
Please refer to others stream_*_url fields to get a stream. This field is rate limited.
The returned url is secured: it can only be consumed by the user who made the query and it expires after a certain time.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/cdn/source/video/x26m1j4.mkv?auth=... | Private, can-read-my-video-streams role required | N/A |
studio
studioTrue if this video is produced by the Dailymotion studio.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | Value | Private, can-manage-studio role required | N/A |
tags
tagsList of tags attached to this video.
Min length: 1 / Max length: 150
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| array | party, John Doe | Public | Private, can be written by the owner of the object |
thumbnail_60_url
thumbnail_60_urlURL of this video’s thumbnail image (60px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/F83Oh/x60-sjB.jpg | Public | N/A |
thumbnail_62_url
thumbnail_62_urlURL of this video’s thumbnail image (62px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/F83Oh/x62-sjB.jpg | Public | N/A |
thumbnail_120_url
thumbnail_120_urlURL of this video’s thumbnail image (120px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x120-Zfs.jpg | Public | N/A |
thumbnail_180_url
thumbnail_180_urlURL of this video’s thumbnail image (180px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x180-o-x.jpg | Public | N/A |
thumbnail_240_url
thumbnail_240_urlURL of this video’s thumbnail image (240px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x240-tGY.jpg | Public | N/A |
thumbnail_360_url
thumbnail_360_urlURL of this video’s thumbnail image (360px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x360-KuJ.jpg | Public | N/A |
thumbnail_480_url
thumbnail_480_urlURL of this video’s thumbnail image (480px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x480-hw4.jpg | Public | N/A |
thumbnail_720_url
thumbnail_720_urlURL of this video’s thumbnail image (720px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x720-Ec7.jpg | Public | N/A |
thumbnail_1080_url
thumbnail_1080_urlURL of this video’s thumbnail image (1080px height).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://s2.dmcdn.net/CTrg1/x1080-Ec7.jpg | Public | N/A |
thumbnail_url
thumbnail_urlURL of this video’s raw thumbnail (full size respecting ratio).
Some users have the permission to change this value by providing an URL to a custom thumbnail. If you don’t have the permission, the thumbnail won’t be updated.
Note: for live streams, the thumbnail is automatically generated every 5 mn by default; it is not possible anymore to manually refresh the preview. Maximum allowed file size is 10MB
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | [Value](https://s2.dmcdn.net/CTrg1.jpg) | Public | Private, can be written by the owner of the object |
tiny_url
tiny_urlTiny URL of this video.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://dai.ly/sk2k3jd | Public | N/A |
title
titleTitle of this video.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | My video title | Public | Private, can be written by the owner of the object |
updated_time
updated_timeDate and time when this video was last updated.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1404129540 | Public | N/A |
uploaded_time
uploaded_timeDate and time when this video was originally uploaded.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| date | 1287507036 | Public | N/A |
url
urlURL of this video on Dailymotion.
Writing this parameter defines where to download the video source. You may either use this parameter at video creation time or change this parameter later if you want to change this video source afterward.
To change an existing video, the authenticated user may need some additional permissions. You may use the GET /file/upload API resource to upload a video file and create a URL to provide to this method or use an existing URL pointing to your own video file.
Writing to this parameter is subject to rate limiting.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| url | https://www.dailymotion.com/video/x26m1j4 | Public | Private, can be written by the owner of the object |
verified
verifiedTrue if the video is owned by a verified partner.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| boolean | false | Public | N/A |
views_last_day
views_last_dayTotal number of views on this video in the last 24 sliding hours.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 203 | Public | N/A |
views_last_hour
views_last_hourTotal number of views on this video in the last sliding hour.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 4023 | Public | N/A |
views_last_month
views_last_monthTotal number of views on this video in the last 30 sliding days.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 10000 | Public | N/A |
views_last_week
views_last_weekTotal number of views on this video in the last 7 sliding days.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 200000 | Public | N/A |
views_total
views_totalTotal amount of views on this video since its publication.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 300000 | Public | N/A |
width
widthWidth of this video from the source (px).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| number | 320 | Public | N/A |
