WIwistia
Extended Audio Descriptions

List Media Extended Audio Descriptions

Changed on

Lists all extended audio descriptions belonging to the account. Supports pagination and sorting.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization naming a media (any permission) can also be used; it lists the extended audio descriptions of the media the token names.

get/media_extended_audio_descriptions

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/media_extended_audio_descriptions
  • Auth
    HTTP bearer

Query parameters

pageinteger

The page number to retrieve. This cannot be combined with cursor, pagination.

per_pageinteger

The number of medias per page. Use this for both offset pagination and cursor pagination.

enabled0 | 1

If cursor[enabled] is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if cursor[before] or cursor[after] are set.

beforestring

If cursor[before] is set then cursor pagination is enabled and all records before the cursor up to the per_page are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.

afterstring

If cursor[after] is set then cursor pagination is enabled and all records after the cursor up to the per_page are returned.

If cursor[enabled] is set to 1 then cursor pagination is enabled and the first set of records are fetched up to the per_page. Cursor pagination will also be turned on if cursor[before] or cursor[after] are set. Records returned will have a cursor property set which can be used to fetch more records in the same sort_by ordering. The cursor value of the last record can be used to fetch records after the current result set and the cursor of the first record can be used to fetch records before the result set.

NOTE: a cursor value is only valid if the sort_by value hasn't changed from the last fetch. For example, you cannot fetch using sort_by id and then pass that cursor value to a sort_by name.

hashed_ids[]string[]

Filter extended audio descriptions to only those matching these hashed ids.

sort_by'language' | 'created' | 'updated' | 'id'

Field to order by. The default is id.

sort_direction0 | 1

Direction to order by. (0 = desc, 1 = asc; default is 1)

Headers

X-Wistia-API-Versionstring required

Response

Media Extended Audio Descriptions retrieval successful

idstring
ietf_language_tagstring
created_atstring date-time
updated_atstring date-time
cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Changes

  • b86cb2a7b420Revision changes
    • info

      added the new enum value created to the query request parameter sort_by

    • info

      added the new enum value language to the query request parameter sort_by

    • info

      added the new enum value updated to the query request parameter sort_by