List videos

Query Params
string

Restrict the search to videos tagged with these tags. Multiple tags should be comma-separated.

string
enum

Tags search mode:

  • all: A video will only be listed if it has all tags specified in the tags parameter.

  • any: A video will be listed if it has at least one tag specified in the tags parameter.

Default is all.

Allowed:
string

Case-insensitive search in the author, description, link, md5, tags, title, video_key fields and custom fields. Parameter can also include comma-separated list of fields that specifies where search should be done.

Search parameter can be specified in the following ways:

  • search: Only videos that contain search string in at least one of the default search fields will be listed. Default search fields are: author, description, tags, title and video_key.

  • search:*: Only videos that contain search string in at least one of the search fields will be listed. Search fields are: author, description, link, md5, tags, title and video_key.

  • search:field1[,field2]: Only videos that contain search string in at least one of the fields specified in the list will be listed. Multiple fields in the list must be comma-separated. Allowed fields are: author, description, link, md5, tags, title and video_key.

  • search:custom.*: Only videos that contain search string in at least one of the custom fields will be listed.

  • search:custom.field1[,custom.field2]: Only videos that contain search string in at least one of the custom fields specified in the list will be listed. Multiple fields in the list must be comma-separated.

  • search:field1[,field2],custom.field1[,custom.field2]: Only videos that contain search string in at least one of the search or custom fields specified in the list will be listed. Multiple fields in the list must be comma-separated.

    An * wildcard field can be used if search should be done in all search fields and/or all custom search fields. For example:

    search:*,custom.field1,custom.field2
    
    search:field1,field2,custom.*
    
    search:*,custom.*
    
string
enum

List only videos with the specified media types. Filter string can include the following media types:

  • unknown: List only videos with media type unknown.

  • audio: List only videos with media type audio.

  • video: List only videos with media type video.

Each media type in the filter string should be separated by a comma. By default media types filter is not applied.

Allowed:
string
enum

List only videos with the specified statuses. Filter string can include the following statuses:

  • created: List only videos with status created.

  • processing: List only videos with status processing.

  • ready: List only videos with status ready.

  • updating: List only videos with status updating.

  • failed: List only videos with status failed.

Each status in the filter string should be separated by a comma. By default the following status filters are applied: processing,ready,updating,failed.

Allowed:
string

List only videos with the specified video keys. Each video_key in the filter string should be separated by a comma. By default video keys filter is not applied.

string

Specifies parameters by which returned result should be ordered. Parameter sort order can be specified by appending :asc for an ascending sort order or :desc for a descending one to the parameter name. Default sort order is ascending and can be omitted. Multiple parameters should be separated by a comma.

Result can be ordered by the following parameters: key, title, description, date, link, author, size, duration, expires_date, status and updated.

Default is date:asc.

integer

(unsigned integer) Video creation date starting from which videos list should be returned. Date must be an UTC date in Unix timestamp format.

integer

(unsigned integer) Video creation date until (and including) which videos list should be returned. Date must be an UTC date in Unix timestamp format.

integer

(unsigned integer) Video update date after which videos should be returned. Date must be an UTC date in Unix timestamp format.

integer

(unsigned integer) Specifies maximum number of videos to return. Default is 50. Maximum result limit is 1000.

integer

(unsigned integer) Specifies how many videos should be skipped at the beginning of the result set. Default is 0.

Headers
string
enum
Defaults to application/xml

Generated from available response content types

Allowed:
Response

Language
URL
Response
Choose an example:
Response
© 2007- Longtail Ad Solutions, Inc.