List video embedding tasks

GET

This method returns a list of the video embedding tasks in your account. The platform returns your video embedding tasks sorted by creation date, with the newest at the top of the list.

Notes
  • Video embeddings are stored for seven days
  • When you invoke this method without specifying the started_at and ended_at parameters, the platform returns all the video embedding tasks created within the last seven days.

Query parameters

started_atstringOptional

Retrieve the video embedding tasks that were created after the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).

ended_atstringOptional

Retrieve the video embedding tasks that were created before the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).

statusstringOptional

Filter video embedding tasks by their current status. Possible values are processing, ready, or failed.

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

Response

A list of video embedding tasks has successfully been retrieved.

datalist of objectsOptional

An array that contains up to page_limit video embedding tasks.

page_infoobjectOptional

An object that provides information about pagination.

Errors

Built with