Session Analytics

  • Here are many session analytics APIs which will return all analytics information about
    sessions.
  • It will return the list of session analytics data such as how many attendees registered for a session, how many attendees joined a session, duration of a session, average attendance of a session, recording views, etc.
  • Here is the information on session analytics APIs.

๐Ÿ“˜

User should have login with Admin/ Super Admin Role or Need a host-side Access.

1. Login as an Admin/ Super Admin

  • Users can utilize this API for login as an admin/ super admin role from the host side.

  • After successful login, it returns data in JSON format which are useful in further requests.

  • Here are Sample Success Responses which API will return.
{
  "access_token": "string",
  "expires_in": "string",
  "redirectUrl": "string",
  "showExhibitorMenu": true,
  "userId": 0,
  "userRole": "string",
  "whiteLabelURL": "string"
}

2. Get All Session Analytics Data

  • This API will return all session's data like session start time, end time,
    session title registered user count, average attended duration, and recording views.
  • Here are Sample Success Responses which API will return.
{
  "recordsTotal": 2,
  "recordsFiltered": 2,
  "data": [
    {
      "sessionId": 25518,
      "title": "Zoom Breakout Session",
      "startTime": "2021/11/22 17:40",
      "endTime": "2021/11/26 18:50",
      "registeredUserCount": 10,
      "attendeeCount": 8,
      "duration": 0,
      "avgAttendedDuraavgRecordingDurationtion": null,
      "": null,
      "recordingViews": 0,
      "liveViews": 0
    },
    {
      "sessionId": 25516,
      "title": "Vimeo Session",
      "startTime": "2021/11/22 17:42",
      "endTime": "2021/11/22 17:50",
      "registeredUserCount": 9,
      "attendeeCount": 8,
      "duration": 285,
      "avgAttendedDuration": 28.845625,
      "avgRecordingDuration": null,
      "recordingViews": 6,
      "liveViews": 0
    }
  ],
  "error": null
}

3. Download The Session Overview CSV

  • Click on the Analytics -> Sessions -> Download -> Session Overview
    It will download the session overview CSV.

  • This API will return session data such as how many attendees are registered,
    how much time an attendee spent in live/ recorded sessions, how many attendees
    joined live/ recorded sessions, etc.

  • Here is a Sample Success Response which API will return.
"Session Name","Session Date","Session Length","Number of Attendees Registered","Number of Views (Live)","Average Watch Time (Live)","Engagement (Live)","Number of Views (Recorded)","Average Watch Time (Recorded)","Engagement (Recorded)"
"Zoom Breakout Session","2021/11/22 17:40","N/A","10","0","N/A","0%","0","N/A","0%"
"Vimeo Session","2021/11/22 17:42","00:04:45","9","8","00:00:28","10.12%","6","00:01:52","39.5%"
"Direct Upload Session","2021/11/22 17:42","00:00:10","6","0","N/A","0%","0","N/A","0%"

4 . Download The Session Attendee Comparison CSV

  • Click on the Analytics -> Sessions -> Download -> Session + Attendee Comparison
    It will download the session attendee comparison CSV.
  • This API will return details of all attendees with all sessions like attendees
    first name, last name, how many sessions joined, etc.
  • Here is a Sample Success Response which API will return.
"Prefix","First Name","Last Name","Email","Please upload a photo of your completed COVID-19 Vaccination Card","Gender","Birthday","Age","Organization","Job title","Image","Upload","Pronouns","What Does Your Company Do?","Facebook","Instagram","LinkedIn","Twitter","WORKSHOP","Direct Upload Session","Networking Session","Vimeo Session","Youtube Session","Zoom Breakout Session","TokBox Main Stage","Voxeet Session","Demo Session","Toxbox","Voxeet","hide","Private Session","session_test","new session_mobile app","test","Testing Session quick wins"
"Mr.","Prahalad","Singh","[email protected]","https://s3.amazonaws.com/v2-dev-images-public/ticket_buyer_uploads/9ccfa2a0-c5a8-4768-8d4e-386472c05756_buildingjpg.jpg","Male","2021-11-01","29","Brill","QA","https://s3.amazonaws.com/v2-dev-images-public/ticket_buyer_uploads/d8270331-f213-4fb7-8fb0-00a44ba1f7be_buildingjpg.jpg","https://s3.amazonaws.com/v2-dev-images-public/ticket_buyer_uploads/bce2f016-35a9-4c62-8fc9-35acde0e1fed_BoardingPasspdf.pdf|BoardingPass.pdf","He/Him","Testing","https://www.facebook.com/","https://www.instagram.com/","https://www.linkedin.com/signup","https://twitter.com/home?lang=en","JOINED","JOINED","JOINED","","JOINED","JOINED","JOINED","","","","","","","","","",""
"Mr.","Nirmal 3","Rathod 3","[email protected]",,,,,,,,,,,,,,,"","","","","","","","","","","","","","","","",""

5. Session Details Analytics

  • When Admin/ Super Admin go to the Analytics -> Sessions -> Session Row
    Then these APIs will call.

a. Download The Session Attendance CSV

  • Click on the particular session Analytics -> Sessions -> Sessions row -> Download Symbol
    It will download session attendance CSV.

  • This API is used to get attendee's information such as how much time was spent on video watching or live in session etc.

  • This API will return attendee data like video duration time (live& recorded),
    watched the recording, attended live, and basic information about the attendee.

  • Here is a Sample Success Response which API will return.
"Attendee First Name","Attendee Last Name","Attendee Email","Registered Date","Attended Live","Duration Time(Live)","Watched Recording","Duration Time(Recorded)"
"Ekta","Kabra","[email protected]","22/11/2021 09:27:09","No","N/A","No","N/A"
"Hina Admin","admin","[email protected]","22/11/2021 12:19:25","Yes","00:00:25","Yes","00:03:16"

b. Get The Video Analytics Data

  • On the host side when we click on Analytics -> Sessions -> Sessions row
    it will give us a session Id and it will return session video analytics data
    such as session data, average attended duration, and average recording view.
  • Here is a Sample Success Response which API will return.
{
  "sessionId": 25559,
  "title": "Toxbox",
  "startTime": "2021/11/22 18:57",
  "endTime": "2021/11/22 19:05",
  "registeredUserCount": null,
  "attendeeCount": null,
  "duration": null,
  "avgAttendedDuration": null,
  "avgRecordingDuration": null,
  "recordingViews": 0,
  "liveViews": 0,
  "totalChatCount": 4,
  "totalRecordingViews": 3,
  "videoAnalytics": {
    "liveView": [
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "0",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "10",
        "userCount": 1
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "15",
        "userCount": 1
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "20",
        "userCount": 1
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "25",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "30",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "35",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "40",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "45",
        "userCount": 2
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "50",
        "userCount": 2
      }
    ],
    "recordingView": [
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "0",
        "userCount": 3
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "10",
        "userCount": 1
      },
      {
        "avgAttendedDuration": 0,
        "avgRecordingDuration": 0,
        "recordingViews": 0,
        "liveViews": 0,
        "hour": "15",
        "userCount": 1
      }
    ]
  }
}

c. Get Attendee By Session Id

  • On the host side when we click on Analytics -> Sessions -> Sessions Row
    It will return the attendee's session details by session Id.

  • This API will return attendee data such as attendance of the session, engagement with the
    session, and basic information of the attendee.

  • Here is a Sample Success Response which API will return.
{
  "attended": true,
  "email": "string",
  "engagement": "string",
  "eventTicketId": 0,
  "firstName": "string",
  "lastName": "string",
  "phoneNumber": 0,
  "registrationDate": "2021-12-21T11:34:37.564Z",
  "userId": 0
}

6. Download Chat CSV

  • On the host side when we click on Analytics -> Sessions -> Sessions row ->
    Analytics -> Download Session Chat
    It will return the attendee's session details by session Id.

  • This API is used to download chat CSV by session Id.

  • CSV contains details of the chat of the attendee like username, message, timestamp, and
    thread messages.

  • Here is a Sample Success Response which API will return.
"User name","Message","Timestamp","Thread Messages"
"heta 2 shah","hello","11/22/2021 17:49:31",""
"Ekta Speaker L1","hello ","11/22/2021 17:49:48",""

7. Download Session Attendees CSV

  • On the host side when we click on Analytics -> Sessions -> Sessions row -> Attendees ->
    Download button
    It will return the attendee's session details by session Id.

  • This API is used to download attendee CSV by session Id.

  • CSV contains each attendee's details like first name, last name, email, and who attended a session.

  • Here is a Sample Success Response which API will return.
"First Name","Last Name","Email","Attended"
"Ekta",,"[email protected]","NO"
"heta 2","shah","[email protected]","YES"
"Ganesh","Jadhav","[email protected]","YES"

8. Download the CSV of Attendee's Sessions Data By User Id

  • On the host side when we click on Analytics -> Sessions -> Sessions row ->
    Attendees -> Download Symbol
    It will return the attendee's session data by user Id.

  • This API will return session data for attendees like session start time, end time,
    session title, status, and engagement data.

  • Here is a Sample Success Response which API will return.
"Session Title","Start Time","End Time","Status","Engagement"
"Vimeo Session","2021/11/22 17:42","2021/11/22 17:50","Attended Live","1.49%"
"Zoom Breakout Session","2021/11/22 17:40","2021/11/26 18:50","Attended Live","0%"
"WORKSHOP","2021/11/22 17:55","2021/11/22 18:30","Attended Live","0%"

9. Download Question Answer CSV for Session

  • On the host side when we click on Analytics -> Sessions -> Sessions row ->
    Q&A -> Download Q&A
    It will return question answer CSV for the session.

  • It will return the session's question and answer data.

  • Here is a Sample Success Response which API will return.
"#","Question","Asker Name","Answer(s)","AnswerType","Status"
"1","lkjlclxc
","aalok mistry","",,"DISMISSED"
"2","sdfgdsh
","Ekta Kabra","","live","ANSWERED"
"3","sdk;sdsd
","aalok mistry","",,"DISMISSED"
"4","hello","Heta Admin Shah","test",,"ANSWERED"
"5","test","Tammy N","",,"DISMISSED"