API Reference

Download the Session Overview CSV

  • API used at host side event admin, super admin, and organizer admin can access this API.
  • This API will return session data like how many attendees are registered,
    attendee how much time is spent in live/Recorded sessions, how many attendees
    join Live/Recorded sessions, etc.
  • We need to pass an authorization token here, which is generated after
    successful login into the account.
AttributeDescription
Session NameSession Name.
Session Date Session start date.
Session Length It is a time length for the session for how much time session will be Live on the platform.
Number of Attendees Registered It is the number of attendees who Registered/Bookmark the session.
Number of Views (Live) It is the number of attendees who watched the Live Session.
Average Watch Time (Live) It is the average watch time for attendees who have watched the live session.
Engagement (Live) It is showing that how much time you are engaged (watch the session) with the Live session.

Formula: Live watch time of all users divided by video duration Multiply by 100.
Number of Views (Recorded) It is the number of attendees who have watched recorded Session
Average Watch Time (Recorded) It is the average watch time for attendees who watched the recorded session.
Engagement (Recorded) It is showing that how much time you are engaged (watch the session) with the recorded session.

Formula: Recorded Watch time of all users divided by video duration multiply by 100.
  • Here are the possible error messages that return if any condition fails or required data is missing for processing.
Error CodeDescription
200OK
400The request could not be understood by the server due to malformed syntax
401You are not authorised to view the resource
403Accessing the resource you were trying to reach is forbidden
404The resource you were trying to reach is not found
406Not Acceptable
4030201Not Event Host
Language
Credentials
Header
Click Try It! to start a request and see the response here!