GET https://api.vidyard.com/dashboard/v1/players/search
Search for players

Search the players available to this user by name, description, tags, internal notes, or UUID. All supplied parameters are combined with AND (a player must match every filter). Results are paginated.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Accept: application/json
GET /v1/players/search.json?name=VBot%20Take&tags[]=thrumbo&page=1&per_page=50

RESPONSE
200 (OK)
{
  "players": [
    {
      "id": 1111,
      "status": "ready",
      "uuid": "kMRx51NXU6fWcjFcuKvthN",
      "name": "VBot Take #418",
      "description": "Sometimes you just gotta keep trying",
      "organization_id": 52819,
      "player_type": "video_facade",
      "duration": 114,
      "tags": [
          "muffalo",
          "thrumbo"
      ],
      "internal_notes": [
          "Discombobulators are not included in this video"
      ],
      "created_at": 1585765358,
      "updated_at": 1585765358
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 50,
    "count": 1
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
name
optional

Filters to players whose name matches this text using word-based search (case-insensitive). Only the first 50 characters are used.

Validations:

  • Must be a String
uuid
optional

Player UUID (exact match)

Validations:

  • Must be a String
description
optional

Filters to players whose description contains this text (case-insensitive)

Validations:

  • Must be a String
tags
optional

Tags assigned to this player. A player must match every supplied tag (case-insensitive, exact match per tag)

Validations:

  • Must be an array of any type
internal_notes
optional

Filters to players whose internal notes contain this text (case-insensitive)

Validations:

  • Must be a String
origin
optional

Filter by video origin (e.g. UPLOAD, DASHBOARD_CAMERA, AVATAR_CAMERA). Values must match the VideoOrigin enum; unrecognized values are ignored.

Validations:

  • Must be an array of any type
page
optional

Page number for search results. Default: 1

Validations:

  • Parameter has to be Integer.
per_page
optional

Number of search results per page. Default: 50, maximum: 200

Validations:

  • Parameter has to be Integer.
include_descendants
optional

Include players inside subfolders
Default: false

Validations:

  • Parameter has to be Boolean.