List indexed assets

The unique identifier of the index for which the platform will retrieve the indexed assets.

A number that identifies the page to retrieve.

Default: 1.

The number of items to return on each page.

Default: 10. Max: 50.

The field to sort on. The following options are available:

• updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was updated.
• created_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created.

Default: created_at.

The sorting direction. The following options are available:

• asc
• desc

Default: desc.

Filter by one or more indexing task statuses. The following options are available:

• ready: The indexed asset has been successfully uploaded and indexed.
• pending: The indexed asset is pending.
• queued: The indexed asset is queued.
• indexing: The indexed asset is being indexed.
• failed: The indexed asset indexing task failed.

To filter by multiple statuses, specify the status parameter for each value:

status=ready&status=validating

Filter by filename.

Filter by duration in seconds. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

Filter by frames per second. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

Filter by width in pixels. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

Filter by height in pixels. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

Filter by size in bytes. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

Filter indexed assets by the creation date and time of their associated indexing tasks, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns indexed assets created on or after the specified date and time.

This filter applies only to indexed assets updated using the PUT method of the /indexes/{index-id}/indexed-assets/{indexed-asset-id} endpoint. It filters indexed assets by the last update date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the indexed assets that were last updated on the specified date at or after the given time.

To enable filtering by custom fields, you must first add user-defined metadata to your video by calling the PUT method of the /indexes/:index-id/indexed-assets/:indexed-asset-id endpoint.

Examples:

• To filter on a string: ?category=recentlyAdded
• To filter on an integer: ?batchNumber=5
• To filter on a float: ?rating=9.3
• To filter on a boolean: ?needsReview=true

Your API key.