Skip to main content

Get Event Information for a Session

Gets information for an event associated with the session. For a list of event fields, types and descriptions, see Event Resources.

Authorizations: Sessions - VIEW

Requests

CODE
GET /apis/sessions/:sessionId/events/:eventId

Response

Success

CODE
{
  "data": {
   "moduleId": "ccf00271-adda-42b4-895f-bb54338fb932",
   "module": "session",
   "startTime": 1592344800,
   "duration": 7200,
   "type": "weekly-recurring",
   "typeData": {"days": ["MON","WED","SAT"]},
   "command": "set-live",
   "parameters": {"record": true},
   "active": true,
   "id": "e808eb59-00c4-4a2e-a0e1-b06a693c7736",
  }
}

Error

Code

Payload

 Description

404

{"code": "040031", "name":"ScheduleEventNotFound",
"message":"Scheduled event not found", "httpStatusCode":404}

The specified event id is incorrect.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.