Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Webcast Reports & Analytics

Use this set of APIs to retrieve various reports, polls, and chat logs once a Webcast event has concluded.  You may also use the real-time reports to retrieve the analytics of an event while it is ongoing.

Get Attendee Webcast Report

Retrieves an attendee report for a specified Webcast with associated details for each attendee. You may specify Pre-Production versus Main Event.

Note: /api/v2/events/{eventId}/report has been deprecated as of v7.36. Use this endpoint instead.

GET
/api/v2/scheduled-events/{eventId}/post-event-report

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve an attendee report for

Request Parameters

Name Type Description Required
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes
scrollId query Reference page data request for the referred event and run item. Used if more than 500 attendees are returned to loop through the remaining data.  

Example Response

{
  "sessions": [
    {
      "userType": "string",
      "name": "string",
      "username": "string",
      "email": "string",
      "ipAddress": "string",
      "browser": "string",
      "deviceType": "string",
      "zone": "string",
      "deviceAccessed": "string",
      "streamAccessed": "string",
      "sessionTime": "string",
      "viewingTime": "string",
      "enteredDate": "2020-08-11T12:47:45.950Z",
      "exitedDate": "2020-08-11T12:47:45.950Z",
      "viewingStartTime": "2020-08-11T12:47:45.950Z",
      "experiencedErrors": 0,
      "multicastErrors": 0,
      "bufferEvents": 0,
      "rebufferEvents": 0,
      "rebufferDuration": 0
    }
  ],
  "totalSessions": 0,
  "scrollId": "string"
}

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error

Example Bad Request

{
  "sessions": [],
  "totalSessions": 0,
  "errorDescription": "string"
}

Get Real-Time Attendees

Retrieves the real-time attendees of a running Webcast.

POST
/api/v2/scheduled-events/{eventId}/real-time/attendees

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve attendees for

Request Parameters

Name Type Description Required
realtimeAttendeesSearchRequest object { } Object that contains the details to search the real the real-time attendees.  Each parameter in the object defined below. Yes
sortField string Default is Full Name  
sortDirection string, optional How data is sorted in the response. Allowed values are asc and desc. Default is asc.  
count number, optional Maximum number of matching records to return in the response. Default is 50. Maximum is 500. Minimum is 1.  
scrollId string, optional    
q string, optional Search query. When specified, searches the search fields with the specified string.  
searchField string, optional

A comma separated list of fields to include in the search. Accepted values include:

  • FullName
  • Email
  • ZoneName
  • StreamType
  • IpAddress
  • Browser
  • OsFamily
  • StreamAccessed
  • PlayerDevice
  • OsName
  • UserType
  • Username
  • AttendeType
  
runNumber number, optional    
attendeeDetails string, optional

Shape of data to return in the response. Supported values include

  • Base
  • All.

Default value is Base. Base returns just UserId, Username, Email, StartTime, SessionId, FullName.

All includes Base details, metrics, session, system, and user details.

  
status string, optional

User session status. Supported values include:

  • All
  • Online
  • Offline.

Default value is All.

  
sortField string, optional Default is Full Name  

Example Response

{
  "scrollId": "string",
  "total": 0,
  "attendees": [
    {
      "UserId": "string",
      "Username": "string",
      "FullName": "string",
      "UserType": "string",
      "AttendeeType": "string",
      "Email": "string",
      "Status": "string",
      "ExperiencedErrors": 0,
      "MulticastFailovers": 0,
      "ExperiencedBufferingDuration": 0,
      "ExperiencedBufferingCount": 0,
      "AvgExperiencedBufferingDuration": 0,
      "AvgBitrateKbps": 0,
      "AvgBandwidthMbps": 0,
      "ZoneId": "string",
      "ZoneName": "string",
      "IpAddress": "string",
      "StreamDevice": "string",
      "StreamAccessed": "string",
      "PlayerDevice": "string",
      "Browser": "string",
      "VideoPlayer": "string",
      "VideoFormat": "string",
      "UserAgent": "string",
      "OsName": "string",
      "OsFamily": "string",
      "DeviceId": "string",
      "RevConnect": true,
      "StreamType": "string",
      "SessionId": "string",
      "ProfileImageUrl": "string"
    }
  ],
  "status": "string"
}

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error

Example Request

{
  "sortField": "string",
  "sortDirection": "string",
  "count": 0,
  "scrollId": "string",
  "q": "string",
  "searchField": "string",
  "runNumber": 0,
  "status": "string",
  "attendeeDetails": "string"
}

Get Comment Log Report

Fetches the comment log for an individual webcast and associated details.

GET
/api/v2/scheduled-events/{eventId}/comments

 

Path Parameters

Name Type Description Required
eventId string GUID for the selected webcast.  

Example Response

 
{
  "username": "string",
  "date": "2018-04-17T14:45:20.824Z",
  "comment": "string"
}

Response Codes

Code Description
401 Unauthorized error
500 Internal server error

Get Webcast Poll Report

Fetches the poll report(s) for an individual webcast with associated details.

GET
/api/v2/scheduled-events/{eventId}/poll-results

 

Path Parameters

Name Type Description Required
eventId string GUID for the selected webcast.  

Example Response

 
{
  "question": "string",
  "totalResponses": 0,
  "totalNoResponses": 0,
  "allowMultipleAnswers": true,
  "pollAnswers": {
    "answer": "string",
    "votes": 0
  }
}

Response Codes

Code Description
401 Unauthorized error
500 Internal server error

Get Attendee Webcast Report

Fetches the attendee report for an individual webcast with associated details for each webcast attendee.

Note: This endpoint has been deprecated as of v7.36. Use the updated endpoint on the Attendee Report instead.

GET
/api/v2/events/{eventId}/report

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve an attendee report for

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error
Post-Event Attendee Report

Get Attendee Webcast Report

Retrieves an attendee report for a specified Webcast with associated details for each attendee. You may specify Pre-Production versus Main Event.

Note: /api/v2/events/{eventId}/report has been deprecated as of v7.36. Use this endpoint instead.

GET
/api/v2/scheduled-events/{eventId}/post-event-report

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve an attendee report for

Request Parameters

Name Type Description Required
runNumber query Currently running runNumber of the referred event. Default to Main Event run number(0). Should be passed for pre-production. Yes
scrollId query Reference page data request for the referred event and run item. Used if more than 500 attendees are returned to loop through the remaining data.  

Example Response

{
  "sessions": [
    {
      "userType": "string",
      "name": "string",
      "username": "string",
      "email": "string",
      "ipAddress": "string",
      "browser": "string",
      "deviceType": "string",
      "zone": "string",
      "deviceAccessed": "string",
      "streamAccessed": "string",
      "sessionTime": "string",
      "viewingTime": "string",
      "enteredDate": "2020-08-11T12:47:45.950Z",
      "exitedDate": "2020-08-11T12:47:45.950Z",
      "viewingStartTime": "2020-08-11T12:47:45.950Z",
      "experiencedErrors": 0,
      "multicastErrors": 0,
      "bufferEvents": 0,
      "rebufferEvents": 0,
      "rebufferDuration": 0
    }
  ],
  "totalSessions": 0,
  "scrollId": "string"
}

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error

Example Bad Request

{
  "sessions": [],
  "totalSessions": 0,
  "errorDescription": "string"
}
Real-Time Attendee Analytics

Get Real-Time Attendees

Retrieves the real-time attendees of a running Webcast.

POST
/api/v2/scheduled-events/{eventId}/real-time/attendees

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve attendees for

Request Parameters

Name Type Description Required
realtimeAttendeesSearchRequest object { } Object that contains the details to search the real the real-time attendees.  Each parameter in the object defined below. Yes
sortField string Default is Full Name  
sortDirection string, optional How data is sorted in the response. Allowed values are asc and desc. Default is asc.  
count number, optional Maximum number of matching records to return in the response. Default is 50. Maximum is 500. Minimum is 1.  
scrollId string, optional    
q string, optional Search query. When specified, searches the search fields with the specified string.  
searchField string, optional

A comma separated list of fields to include in the search. Accepted values include:

  • FullName
  • Email
  • ZoneName
  • StreamType
  • IpAddress
  • Browser
  • OsFamily
  • StreamAccessed
  • PlayerDevice
  • OsName
  • UserType
  • Username
  • AttendeType
  
runNumber number, optional    
attendeeDetails string, optional

Shape of data to return in the response. Supported values include

  • Base
  • All.

Default value is Base. Base returns just UserId, Username, Email, StartTime, SessionId, FullName.

All includes Base details, metrics, session, system, and user details.

  
status string, optional

User session status. Supported values include:

  • All
  • Online
  • Offline.

Default value is All.

  
sortField string, optional Default is Full Name  

Example Response

{
  "scrollId": "string",
  "total": 0,
  "attendees": [
    {
      "UserId": "string",
      "Username": "string",
      "FullName": "string",
      "UserType": "string",
      "AttendeeType": "string",
      "Email": "string",
      "Status": "string",
      "ExperiencedErrors": 0,
      "MulticastFailovers": 0,
      "ExperiencedBufferingDuration": 0,
      "ExperiencedBufferingCount": 0,
      "AvgExperiencedBufferingDuration": 0,
      "AvgBitrateKbps": 0,
      "AvgBandwidthMbps": 0,
      "ZoneId": "string",
      "ZoneName": "string",
      "IpAddress": "string",
      "StreamDevice": "string",
      "StreamAccessed": "string",
      "PlayerDevice": "string",
      "Browser": "string",
      "VideoPlayer": "string",
      "VideoFormat": "string",
      "UserAgent": "string",
      "OsName": "string",
      "OsFamily": "string",
      "DeviceId": "string",
      "RevConnect": true,
      "StreamType": "string",
      "SessionId": "string",
      "ProfileImageUrl": "string"
    }
  ],
  "status": "string"
}

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error

Example Request

{
  "sortField": "string",
  "sortDirection": "string",
  "count": 0,
  "scrollId": "string",
  "q": "string",
  "searchField": "string",
  "runNumber": 0,
  "status": "string",
  "attendeeDetails": "string"
}
Comment Log Report

Get Comment Log Report

Fetches the comment log for an individual webcast and associated details.

GET
/api/v2/scheduled-events/{eventId}/comments

 

Path Parameters

Name Type Description Required
eventId string GUID for the selected webcast.  

Example Response

 
{
  "username": "string",
  "date": "2018-04-17T14:45:20.824Z",
  "comment": "string"
}

Response Codes

Code Description
401 Unauthorized error
500 Internal server error
Poll Reports

Get Webcast Poll Report

Fetches the poll report(s) for an individual webcast with associated details.

GET
/api/v2/scheduled-events/{eventId}/poll-results

 

Path Parameters

Name Type Description Required
eventId string GUID for the selected webcast.  

Example Response

 
{
  "question": "string",
  "totalResponses": 0,
  "totalNoResponses": 0,
  "allowMultipleAnswers": true,
  "pollAnswers": {
    "answer": "string",
    "votes": 0
  }
}

Response Codes

Code Description
401 Unauthorized error
500 Internal server error
Attendee Report (Deprecated)

Get Attendee Webcast Report

Fetches the attendee report for an individual webcast with associated details for each webcast attendee.

Note: This endpoint has been deprecated as of v7.36. Use the updated endpoint on the Attendee Report instead.

GET
/api/v2/events/{eventId}/report

Path Parameters

Name Type Description
eventId string Webcast Id to to retrieve an attendee report for

Response Codes

Code Description
400 Bad request
401 Unauthorized error
500 Internal server error