List videos



RESPONSE PARAMETERS

ParameterDescription
limit number(unsigned integer) Maximum number of videos that should be return. As specified in the result_limit request parameter.
offset number(unsigned integer) Number of videos that should be skipped at the beginning of the result set. As specified in the result_offset request parameter.
rate_limit objectNumber of requests that can be made to a route per minute per property

Only 30 calls per minute per property can be made.

See: rate_limit object
status stringCall execution status

Set to ok if the call executed successfully.
total nubmer(unsigned integer) Total number of videos available.
videos array of objectsProperties of videos

See: videos object

rate_limit

ParameterDescription
limit numberTotal number of requests that can be made to this route before the reset time
remaining numberNumber of remaining requests that can be made to this route before the reset time
reset numberUnix timestamp identifying when the rate limit renews

videos

ParameterDescription
author stringAuthor of the video
custom objectProperty consisting of a user-defined parameter and a user-defined key
date number(signed integer) Video publish date. Specifies UTC date and time (in Unix timestamp format) when the video will be available for streaming.
description stringDescription of the video
duration number(float) Duration of the video in seconds
error object | stringNot empty if processing of the initial or re-uploaded original file or their default conversion has failed.

When /video/status is failed, error message corresponds to the initially uploaded original file or its default conversion, or to the last re-uploaded original file or its default conversion (if initial upload also has failed).

When /video/status is ready, error message corresponds to the last re-uploaded original file or its default conversion.
expires_date number(signed integer) Video publish expiration date. Specifies UTC date and time (in Unix timestamp format) when the video will stop being available for streaming.
key stringVideo key
link stringThe URL of the web page where this video is published
md5 stringMD5 hash of the original file
mediatype stringContent media type:

unknown: Media type is unknown.
audio: Media type is audio.
video: Media type is video.
size number(unsigned integer) Combined size of all conversions created for this video in bytes.
sourceformat stringVideo source format:

mp4: Video MIME type is video/mp4.
webm: Video MIME type is video/webm.
flv: Video MIME type is video/flv.
aac: Audio MIME type is audio/aac.
mp3: Audio MIME type is audio/mpeg.
vorbis: Audio MIME type is type audio/ogg.
m3u8: For a HLS M3U8 manifest URL.
smil: For a SMIL manifest URL.
sourceurl stringURL of the video source. Only if sourcetype is set to url. If sourceformat is youtube, sourceurl can be specified as a full URL to the YouTube video or as an YouTube Video ID.
sourcetype stringSource type of the video.
file: Video source type is file.
status stringVideo status:

created: Video is created. Waiting for the original file upload being complete.

processing: Original file or default conversion is being processed.

ready: Video ready for streaming (original and default conversion are ready).

updating: New (re-uploaded) original file is being processed. Previous original file and default conversion are ready for streaming.

failed: Processing of the original file or default conversion has failed.
tags stringTags of the video
title stringTitle of the video
updated number(signed integer) Video update date. Specifies UTC date and time (in Unix timestamp format) when the video was updated for the last time.
upload_session_id stringResumable upload session ID
views string
Total video views since video has been created.

WARNING: This property is a legacy system metric that has been deprecated since 2016-07-01. The value returned here is not an accurate representation of video views or plays.

Language
URL