WIwistia
Review Bundles

List Review Bundles

Changed on

Lists review bundles belonging to an account. This endpoint can also be used to do a batch fetch based off of the hashed id, or to find the bundles that include a given media or any media from a folder.

Requires api token with one of the following permissions

Read all folder and media data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization naming a review bundle (any permission) can also be used; it lists the review bundles the token names.

get/review_bundles

Request

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

Query parameters

hashed_ids[]string[]

Restrict the results to the review bundles with these hashed IDs.

namestring

Restrict the results to review bundles whose name contains this value (case-insensitive).

media_hashed_idstring

Restrict the results to review bundles that include the media with this hashed ID.

folder_hashed_idstring

Restrict the results to review bundles that include any media from the folder with this hashed ID.

sort_by'id' | 'name' | 'created' | 'updated'

Field to order by. The default is id.

sort_direction0 | 1

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

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.

Headers

X-Wistia-API-Versionstring required

Response

Review Bundles retrieval successful

hashed_idstring

A unique alphanumeric identifier for this review bundle.

namestring

The bundle display name.

urlstring

The URL of the bundle.

allow_downloadsboolean

Whether the videos in the bundle can be downloaded.

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].

Example response

[
  {
    "name": "My Review Bundle Title",
    "url": "https://[your-domain].wistia.com/reviews/bundles/1234567890"
  }
]

Changes