View active features.
Get an organization’s available features
| 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)
{
"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",
"config_settings": { }
},
{
"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"
"config_settings": { }
}
],
"summary": {
"page": 1,
"per_page": 5,
"count": 2
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get organizations having a feature
| 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)
{
"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
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get a feature within 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)
{
"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": { }
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
DEPRECATED
Get a feature within 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)
{
"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": { }
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Get usages for a feature within an organization - requires view access to billing
| 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)
{
"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
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
user_ids optional , nil allowed |
A list of user_ids to select usages from Validations:
|
Get allotments for a feature within an organization - requires view access to billing
| 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)
{
"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
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
created_by_ids optional , nil allowed |
A list of created_by_ids to select allotments from Validations:
|