Attributes

View, create and delete custom attributes within a Vidyard account. Attributes are included in the view data for the associated player.

Supported Formats

json
>>>

GET https://api.vidyard.com/dashboard/v1/attributes
Gets one or more custom attributes

Gets one or more custom attributes

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
{
  "attributes": [
    {
      "attribute_type": "String",
      "created_at": "2015-07-13T19:53:17Z",
      "id": 12964,
      "name": "awesome",
      "organization_id": 98645,
      "is_public": false,
      "updated_at": "2015-07-13T19:53:17Z"
    },
    {
      "attribute_type": "String",
      "created_at": "2015-07-13T20:31:09Z",
      "id": 45863,
      "name": "a default value",
      "organization_id": 98645,
      "is_public": true,
      "updated_at": "2015-07-13T20:31:09Z"
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 50,
    "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
per_page
optional

The number of items shown per page
Maximum: 200

Validations:

  • Parameter has to be Integer.
page
optional

The page number included in the response
Only applied when per_page is used
Default: 1

Validations:

  • Parameter has to be Integer.
>>>

GET https://api.vidyard.com/dashboard/v1/attributes/default
Gets one or more default attributes

Gets one or more default attributes

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
[
  {
    "name": "a default value",
    "value": "some value",
    "attribute_type": "String",
    "is_public": true,
    "list_options": null
  },
  {
    "name": "session",
    "value": "asc1297",
    "attribute_type": "String",
    "is_public": false,
    "list_options": null
  }
]

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/attributes", "/v1/players/uuid=:player_uuid/attributes"]
Gets the custom attributes for the specified player

Gets the custom attributes for the specified 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
[
  {
    "name": "awesome",
    "value": "This is great.",
    "attribute_type": "String",
    "is_public": false,
    "list_options": null
  },
  {
    "name": "a default value",
    "value": "some value",
    "attribute_type": "String",
    "is_public": true,
    "list_options": null
  }
]

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

POST https://api.vidyard.com/dashboard/v1/attributes/default
Creates a new default attribute

Creates a new default attribute that can be attached to a player or 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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "name": "awesome",
  "attribute_type": "Integer",
  "is_public": true,
  "value": "34"
}

RESPONSE
201 (Created)
{
  "name": "awesome",
  "attribute_type": "Integer",
  "value": 34,
  "is_public": true,
  "list_options": null
}

REQUEST
Content-Type: application/json
{
  "name": "Colors",
  "attribute_type": "List",
  "value": "Red",
  "list_options": ["Red","Green","Blue"]
}

RESPONSE
201 (Created)
{
  "name": "Colors"
  "attribute_type": "List"
  "value": "Red",
  "list_options": ["Red","Green","Blue"],
  "is_public": false
}

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 attribute
Minimum length: 2 bytes
Maximum length: 255 bytes

Validations:

  • Must be a String
attribute_type
optional

Valid types are String, Boolean, Integer, or List.
If not provided, the default type is String unless the attribute already exists for the organization.

Validations:

  • Must be a String
list_options
optional , nil allowed

If creating a List type, this array of Strings is required to define the options for the list.

Validations:

  • Must be an array of any type
value
required

A default value for this attribute.
This is included with all players and videos by default.
Maximum length: 255 bytes

Validations:

  • Must be a String
is_public
optional

Determines if this attribute is hidden from a viewer or not

Validations:

  • Parameter has to be Boolean.
>>>

POST https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"]
Creates a new player attribute

Creates a new attribute attached to specified 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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "name": "awesome",
  "attribute_type": "Integer",
  "value": "34"
}

RESPONSE
201 (Created)
{
  "name": "awesome",
  "attribute_type": "Integer",
  "value": 34,
  "list_options": null
  "is_public": false
}

REQUEST
Content-Type: application/json
{
  "name": "Colors",
  "attribute_type": "List",
  "value": "Red",
  "list_options": ["Red","Green","Blue"],
  "is_public": true
}

RESPONSE
201 (Created)
{
  "name": "Colors"
  "attribute_type": "List"
  "value": "Red",
  "list_options": ["Red","Green","Blue"],
  "is_public": true
}

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 attribute
Minimum length: 2 bytes
Maximum length: 255 bytes

Validations:

  • Must be a String
attribute_type
optional

Valid types are String, Boolean, Integer, or List.
If not provided, the default type is String unless the attribute already exists for the organization.

Validations:

  • Must be a String
list_options
optional , nil allowed

If creating a List type, this array of Strings is required to define the options for the list.

Validations:

  • Must be an array of any type
value
required

A value for this attribute specific to this player.
Maximum length: 255 bytes

Validations:

  • Must be one of: String, Integer.
is_public
optional

Determines if this attribute is hidden from a viewer or not

Validations:

  • Parameter has to be Boolean.
>>>

PUT https://api.vidyard.com/dashboard/v1/attributes/default
Updates a default custom attribute value

Updates the default value of a custom attribute

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
{
  "attributes": [
    {
      "name": "awesome",
      "value": "Testing"
    },
    {
      "name": "department",
      "value": "Sales",
      "is_public": true
    }
  ]
}

RESPONSE
200 (OK)
{
  "attributes": [
    {
      "name": "awesome"
      "attribute_type": "String"
      "value": "Testing",
      "list_options": null,
      "is_public": false
    },
    {
      "name": "department"
      "attribute_type": "String"
      "value": "Sales",
      "list_options": null,
      "is_public": true
    }
  ],
  "errors": []
}

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

PUT https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"]
Updates a player custom attribute value

Updates the value of a custom attribute for specified 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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "attributes": [
    {
      "name": "awesome",
      "value": "Testing",
      "is_public": true
    },
    {
      "name": "department",
      "value": "Sales"
    }
  ]
}

RESPONSE
200 (OK)
{
  "attributes": [
    {
      "name": "awesome"
      "attribute_type": "String"
      "value": "Testing",
      "list_options": null,
      "is_public": true
    },
    {
      "name": "department"
      "attribute_type": "String"
      "value": "Sales",
      "list_options": null,
      "is_public": false
    }
  ],
  "errors": []
}

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

DELETE https://api.vidyard.com/dashboard/v1/attributes/:name
Deletes all instances of a custom attribute

Deletes all instances of a custom attribute

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

RESPONSE
{
  "name": "awesome",
  "attribute_type": "String",
  "value": "Testing",
  "list_options": null,
  "is_public": false
}

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

DELETE https://api.vidyard.com/dashboard/v1/attributes/default/:name
Deletes a default custom attribute value

Deletes a default custom attribute value

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

RESPONSE
{
  "name": "awesome",
  "attribute_type": "String",
  "value": "Testing",
  "list_options": null,
  "is_public": false
}

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

DELETE https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes/:name", "/v1/players/uuid=:player_uuid/attributes/:name"]
Deletes a custom attribute value for specified player

Deletes a custom attribute value for a specified 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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "name": "awesome",
  "attribute_type": "String",
  "value": "Testing",
  "list_options": null,
  "is_public": false
}

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