View, create and delete Vidyard tags.
Create a new tag that can be attached to a video object.
IMPORTANT CHANGE TO ENDPOINT: Using this endpoint with the “Video” as the taggable_type will return inconsistent data in any future reads. All new tags should be created using “Player” or “UploaderWidget” as the taggable_type.
| 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 |
REQUEST
Content-Type: application/json
{
"name": "awesome",
"taggable_type": "Video",
"taggable_id": 256
}
RESPONSE
201 (Created)
{
"name": "awesome",
"taggable_type": "Video",
"taggable_id": 256
"id": 130,
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
name required |
A unique tag Validations:
|
|
taggable_type required |
Is this tagging a video, a player, an uploader widget, or a template? Validations:
|
|
taggable_id required |
The ID of the video, player, uploader widget, or template this tag is for Validations:
|
Get a single tag
| 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 |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"name": "awesome",
"id": 256,
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Used to uniquely identify a tag Validations:
|
Get one or more tags
| 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 |
REQUEST
Accept: application/json
RESPONSE
{
"tags": [
{
"name": "awesome",
"id": 256,
"organization_id": 2,
},
{
"name": "Cat-tastic",
"id": 367,
"organization_id": 2,
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 100
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
|
taggable_id optional |
Response contains all tags associated to videos, players, and uploader widgets with this id Validations:
|
|
name optional |
Response will contain a single tag Validations:
|
DEPRECATED
Get all distinct tag names for an organization
| 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 |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"tags": [
{
"name": "awesome",
},
{
"name": "Cat-tastic",
}
],
"summary": {
"page": 1,
"per_page": 10,
"count": 2
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
query optional |
Response will contain an array of tag names containing the given string Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
DEPRECATED
Delete tags
| 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 |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id optional |
You can delete a tag by supplying only the tag id Validations:
|
|
name optional |
You can remove a tag from a player by specifying the name of the tag as well as the taggable_type and taggable_id of the player, or uploader widget Validations:
|
|
taggable_type optional |
You can remove a tag from a player by specifying the name of the tag as well as the taggable_type and taggable_id of the player, or uploader widget Validations:
|
|
taggable_id optional |
You can remove a tag from a player by specifying the name of the tag as well as the taggable_type and taggable_id of the player, or uploader widget Validations:
|