View active features.

Supported Formats

json

GET https://api.vidyard.com/dashboard/v1/features
Get an organization's available features

Get an organization’s available features

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)
{
  "features": [
  {
    "id": 24,
    "unique_name": "access_codes",
    "friendly_name": "Player Access Codes",
    "description": "Allows you to specify an access code that a user must know in order to view the Player",
  },
  {
    "id": 43,
    "unique_name": "thumbnail_split_test",
    "friendly_name": "A/B Split Test Thumbnails",
    "description": "Determine what image of your video asset is going to generate the highest click through rate"
  }
],
"summary": {
  "page": 1,
  "per_page": 5,
  "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


GET https://api.vidyard.com/dashboard/v1/features/:unique_name/organizations
Get organizations having a feature

GET https://api.vidyard.com/dashboard/v1/features/:feature_id/organizations
Get organizations having a feature

Get organizations having a feature

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)
{
  "organizations": [
    {
      "name": "it@marketing.com",
      "id": 28,
      "parent_id": 1,
      "org_type": null,
      "created_at": 1392405501,
      "updated_at": 1392405501,
      "embed_domain": "http://embed.vidyard.com",
      "secure_embed_domain": "https://secure.vidyard.com",
      "playback_domain": "//play.vidyard.com"
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 200,
    "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


GET https://api.vidyard.com/dashboard/v1.1/organizations/:organization_id/features/unique_name=:unique_name
Get a feature within an organization

Get a feature within 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)
{
  "id": 24,
  "unique_name": "access_codes",
  "friendly_name": "Player Access Codes",
  "description": "Allows you to specify an access code that a user must know in order to view the Player",
  "config_settings": { }
}

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/organizations/:organization_id/features/unique_name=:unique_name DEPRECATED
Get a feature within an organization

Get a feature within 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)
{
  "id": 24,
  "unique_name": "access_codes",
  "friendly_name": "Player Access Codes",
  "description": "Allows you to specify an access code that a user must know in order to view the Player",
  "config_settings": { }
}

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/features/:unique_name/usages
Get usages on a feature within an organization

GET https://api.vidyard.com/dashboard/v1/features/:feature_id/usages
Get usages on a feature within an organization

Get usages for a feature within an organization - requires view access to billing

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)
{
  "feature_usages": [
    {
      "id": 1,
      "organization_id": 9001,
      "feature_id": 55,
      "consumable_id": 2,
      "consumable_type": "Organization",
      "amount": 1,
      "user_id": 5001,
      "created_at": 1392405501,
      "updated_at": 1392405501
    },
      "id": 2,
      "organization_id": 9001,
      "feature_id": 55,
      ...
    }
  ]
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

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

user_ids
optional , nil allowed

A list of user_ids to select usages from

Validations:

  • Must be an array of any type


GET https://api.vidyard.com/dashboard/v1/features/:unique_name/allotments
Get allotments for a feature within an organization

GET https://api.vidyard.com/dashboard/v1/features/:feature_id/allotments
Get allotments for a feature within an organization

Get allotments for a feature within an organization - requires view access to billing

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)
{
  "feature_allotments": [
    {
      "id": 1,
      "organization_id": 9001,
      "feature_id": 55,
      "amount": 50,
      "created_by": 1
      "created_at": 1392405501,
      "updated_at": 1392405501
    },
      "id": 2,
      "organization_id": 9001,
      "feature_id": 55,
      ...
    }
  ]
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

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

created_by_ids
optional , nil allowed

A list of created_by_ids to select allotments from

Validations:

  • Must be an array of any type