View, create and delete call to actions.

Supported Formats

json

POST https://api.vidyard.com/dashboard/v1/events
Create a new event

Create a new event

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
{
  "html": "<div class=\"main\">Checkout my CTA!</div>",
  "event_type": "marketo_form"
}

RESPONSE
201 (Created)
{
  "id": 1024,
  "html": "<div class=\"main\">Checkout my CTA!</div>",
  "event_type": "marketo_form",
  "created_at": 1374261385,
  "updated_at": 1374261385
}

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

User-friendly name for the event

Validations:

  • Must be a String

description
optional

User-friendly description for the event’s contents

Validations:

  • Must be a String

fullscreen
optional

Determines if the event should be displayed as a fullscreen event

Validations:

  • Parameter has to be Boolean.

background_color
optional

Background color for the event’s container

Validations:

  • Must be a String

annotation_css
optional

CSS values for width and height, top and left position, annotation background color, and opacity

Validations:

  • Must be an array of any type

blur
optional

Amount to blur the video by when a fullscreen event is displayed

Validations:

  • Parameter has to be Integer.

event_type
optional

The type of Event to create: “simple_post_roll”, “simple_overlay”, “simple_email”, “fullscreen”, “annotation”, “marketo_form”

Validations:

  • Must be a String

html
required

HTML this Event will display. May include JavaScript and HTML forms.

Validations:

  • Must be a String

closeable
optional

Allow the Event to be closed (skipped) by viewers.

Validations:

  • Parameter has to be Boolean.


GET https://api.vidyard.com/dashboard/v1/events
Get all events belonging to your organization.

Get all events belonging to your 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": 8192
    "event_type": "fullscreen",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  },
  {
    "id": 9297
    "event_type": "fullscreen",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  }
]

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.


GET https://api.vidyard.com/dashboard/v1/events/search
Search for events belonging to your organization.


POST https://api.vidyard.com/dashboard/vi/events/:id/duplicate
Make a copy of an event.

Make a copy of an event.

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
{
  name: "This is a duplicate of 23"
  organization_id: 2
}

RESPONSE
201 (Created)
{
  "id": 24,
  "name": "This is a duplicate of 23"
  "html": "<div class=\"main\">Checkout my CTA!</div>",
  "organization_id": 2,
  "created_at": 1374261385,
  "updated_at": 1374261385
}

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

The ID of the event to be duplicated

Validations:

  • Parameter has to be Integer.

organization_id
optional

The ID of the organization the event will be duplicated to.

Validations:

  • Parameter has to be Integer.

name
optional

The name to assign to the duplicate event. If not provided, the event will retain the name with (copy) appended to the end.

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/events/:id
Get a single event.

Get a single event.

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": 8192,
  "event_type": "fullscreen",
  "html": "<div class=\"main\">Checkout my CTA!</div>",
  "created_at": 1374261385,
  "updated_at": 1374261385
}

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/dashboardv1/events/:id/owner_meta
Get information about events attached to chapters

Get information about the players associated with an event

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": "My Player",
  "width": 640,
  "height": 360,
  ...
  "chapters_attributes": [{
    "id": 1,
    "created_at": 1506710125,
    "updated_at": 1506710125,
    "position": 0,
    "player_id": 1,
    "video_id": 1,
    "video_attributes": {
      "name": "My Video",
      "upload_url": "http://www.example.com/video.mp4",
      "current_thumbnail_attributes": null,
      ...
    },
    "event_attributes": [{
      "id": 1,
      "created_at": 1506710125,
      "updated_at": 1506710125,
      "owner_type": "Chapter",
      "owner_id": 1,
      "event_id": 1,
      "second": 2,
      "duration": 1,
      "annotation_css": 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


PATCH https://api.vidyard.com/dashboard/v1/events/:id
Update an event.

Update an event.

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
{
  "name": "This gets a new name",
  "html": "<div class=\"main\">Check out my event!</div>",
}

RESPONSE
200 (OK)
{
  "id": 23,
  "name": "This gets a new name",
  "html": "<div class=\"main\">Check out my event!</div>",
  "organization_id": 2,
  "event_type": "fullscreen",
  "prefill": false,
  "created_at": 1374261385,
  "updated_at": 1374261385,
  ...
}

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/events/:id
Delete an event

Delete a call to action

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
{
  "event_type": "fullscreen",
  "html": "<div class=\"main\">Checkout my CTA!</div>",
  "id": 8192,
  "created_at": 1374261385,
  "updated_at": 1374261385
}

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/uuid=:uuid/event_meta
Get the event metadata for a player

Get the event metadata 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
{
  "max_events_width": 350,
  "num_public_events": 11,
  "num_draft_events": 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