View, create and delete Vidyard tags.

Supported Formats

json

POST https://api.vidyard.com/dashboard/v1/tags
Create a new tag

Create a new tag that can be attached to a video object

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
Content-Type: application/json
{
  "name": "awesome",
  "taggable_type": "Video",
  "taggable_id": 256
}

RESPONSE
201 (Created)
{
  "name": "awesome",
  "id": 256,
}

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
required

A unique tag
Minimum length: 2 characters
Maximum length: 100 characters

Validations:

  • Must be a String

taggable_type
required

Is this tagging a video, a player, or an uploader widget?

Validations:

  • Must be one of: Video, Player, UploaderWidget.

taggable_id
required

The ID of the video, player, or uploader widget this tag is for

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/tags/:id
Get a single tag

Get a single tag

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

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "name": "awesome",
  "id": 256,
}

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

id
required

Used to uniquely identify a tag

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/tags
Get one or more tags

Get one or more tags

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

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "tags": [
    {
      "name": "awesome",
      "id": 256,
    },
    {
      "name": "Cat-tastic",
      "id": 367,
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 100
  }
}

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

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.

taggable_id
optional

Response contains all tags associated to videos, players, and uploader widgets with this id

Validations:

  • Parameter has to be Integer.

name
optional

Response will contain a single tag

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/videos/:video_id/tags
Get all tags for a Video

Get all tags for a Video

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

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
[
  {
    "name": "awesome",
    "id": 256,
  },
  {
    "name": "Cat-tastic",
    "id": 367,
  }
]

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


GET https://api.vidyard.com/dashboard/v1/players/:player_id/tags
Get all tags for a Player

Get all tags for a Player

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

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
[
  {
    "name": "awesome",
    "id": 256,
  },
  {
    "name": "Cat-tastic",
    "id": 367,
  }
]

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


GET https://api.vidyard.com/dashboard/v1/tags/names
Get all distinct tag names

Get all distinct tag names for an organization

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

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "tags": [
    {
      "name": "awesome",
    },
    {
      "name": "Cat-tastic",
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 10,
    "count": 2
  }
}

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

query
optional

Response will contain an array of tag names containing the given string

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Default: 10

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Default: 1

Validations:

  • Parameter has to be Integer.


PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/tags
Update a Video's tags

Update a Video’s tags

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

Examples

REQUEST
Content-Type: application/json
{
  "tags": [
    {
      "name": "TagExample"
    },
    {
      "name": "Tag2Example"
    }
  ]
}

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

A video’s tag

Validations:

  • Must be a String


PATCH https://api.vidyard.com/dashboard/v1/players/:player_id/tags
Update a Player's tags

Update a Player’s tags

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

Examples

REQUEST
Content-Type: application/json
{
  "tags": [
    {
      "name": "TagExample"
    },
    {
      "name": "Tag2Example"
    }
  ]
}

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

A player’s tag

Validations:

  • Must be a String


DELETE https://api.vidyard.com/dashboard/v1/tags
Delete tags

Delete tags

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

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

id
optional

You can delete a tag by supplying only the tag id
This will remove the tag from all videos, players, and uploader widgets

Validations:

  • Parameter has to be Integer.

name
optional

You can remove a tag from a video or player by specifying the name of the tag as well as the taggable_type and taggable_id of the video, player, or uploader widget

Validations:

  • Must be a String

taggable_type
optional

You can remove a tag from a video or player by specifying the name of the tag as well as the taggable_type and taggable_id of the video, player, or uploader widget

Validations:

  • Must be a String

taggable_id
optional

You can remove a tag from a video or player by specifying the name of the tag as well as the taggable_type and taggable_id of the video, player, or uploader widget

Validations:

  • Parameter has to be Integer.