This article contains the description of all account reports as well as an example of the data included in each report.
Each report is returned as a CSV (Comma Separated Values) formatted string.
In this article we cover:
Analytics report
Type ID: analytics
Version: v2
| Column title | Description |
|---|---|
| Date | Date the session was run, time format: DD-MM-YYYY |
| Session name | Name of the session |
| Owner | Owner of the session |
| E-mail of the session owner | |
| Department | Session owner's department |
| Created date | Date the session was created, time format: DD-MM-YYYY |
| Participants | Total number of participants |
| Active participants | Number of participants that were active in session, this means answered a poll or were active in Q&A |
| Participation rate | Active participants shown as a percentage |
| Polls | Number of polls |
| Poll responses | Number of responses to polls |
| Q&A messages | Number of Q&A messages |
| Likes | Number of likes |
| Surveys | Number of surveys |
| Survey responses | Number of responses to surveys |
| PowerPoint | Indicates if the PPT-addin was used to run the session. 0 is false, 1 is true. |
| Teams | Number of participants that joined the session via Teams |
| Webex | Number of participants that joined the session via Webex |
| Zoom | Number of participants that joined the session via Zoom |
| LTI | Indicates if LTI-connected polls or surveys were used in the session. 0 is false, 1 is true. |
Report example:
"Date","Session name","Owner","Email","Department","Created date","Participants","Active participants","Participation rate","Polls","Poll responses","Q&A messages","Likes","Surveys","Survey responses","PowerPoint","Teams","Webex","Zoom","LTI"
"09.05.2024","My session name","Joe Admin","joe.admin@email.com","","09.05.2024","6","4","66.67","3","12","0","0","4","13","0","1","0","0","0"
"13.05.2024","Awesome session","Jane Admin","jane.admin@email.com","Sales","10.05.2024","8","5","62.50","15","46","0","0","0","0","0","2","0","0","0"
"14.05.2024","My session name","Joe Admin","joe.admin@email.com","","09.05.2024","9","6","66.67","3","5","3","0","4","4","0","0","0","0","1"
"14.05.2024","Awesome session","Jane Admin","jane.admin@email.com","Sales","10.05.2024","10","4","40.00","4","9","1","0","5","0","1","0","0","0","0"
"14.05.2024","Another session","Jane Admin","jane.admin@email.com","Sales","14.05.2024","4","3","75.00","14","16","0","0","1","0","1","0","0","0","0"
"15.05.2024","Session name","John Admin","john.admin@email.com","Development","11.03.2015","3","1","33.33","0","0","2","0","3","0","0","0","0","0","1"Sessions report
Type ID: sessions
Version: v2
| Column title | Description |
| accessCode | Session ID |
| sessionName | Name of session |
| meetingHost | Name of the meeting host |
| hostEmail | Email of the meeting host |
| createdDate | Date the session was created, time format: YYYY-MM-DD HH:MM:SS |
| scheduledDate | Date the session is scheduled, time format: YYYY-MM-DD HH:MM:SS |
| sessionLabels | Session labels, as a comma-separated list |
| coHosts | E-mails of co-hosts, as a comma-separated list |
Report example:
"accessCode","sessionName","meetingHost","hostEmail","createdDate","scheduledDate","sessionLabels","coHosts"
"201059009","Physics","Joe Admin","joe.admin@email.com","2024-05-08 13:06:27","2024-05-08 13:00:00","label1","jane.admin@email.com"
"201474568","Chemistry 1","Joe Admin","joe.admin@email.com","2024-05-08 14:26:48","2024-05-08 14:15:00","","john.admin@email.com"
"201343673","Teams","Jane Admin","jane.admin@email.com","2024-05-13 08:02:32","2024-05-13 08:00:00","label2","joe.admin@email.com,john.admin@email.com"
"201174888","Session 01","John Admin","john.admin@email.com","2024-05-13 12:17:50","2024-05-13 12:15:00","label1,label2,label3",""
"201815408","PowerPoint","John Admin","john.admin@email.com","2024-05-13 12:42:03","2024-05-13 12:30:00","",""
"201132598","Session 02","Jane Admin","jane.admin@email.com","2024-05-14 10:22:31","2024-05-14 10:15:00","label4,label5",""
"201300122","Biology 1","Joe Admin","joe.admin@email.com","2024-05-15 07:27:39","2024-05-14 23:00:00","label2,label5","jane.admin@email.com,john.admin@email.com"
"201501141","Chemistry 2","Joe Admin","joe.admin@email.com","2024-05-15 11:01:49","2024-05-14 23:00:00","","john.admin@email.com"
Q&A Messages report
Type ID: messages
Version: v2 (includes host announcements, check v1 below for getting deprecated host messages)
| Column title | Description |
| accessCode | Session ID |
| meetingHost | Name of the meeting host |
| hostEmail | Email of the meeting host |
| messageTime | Time when message was received in time format: YYYY-MM-DD HH:MM:SS |
| announcementText | Announcement text (each entry is either a host announcement or a message) |
| messageText | Message text (each entry is either a host announcement or a message) |
| messageAuthor | Message author |
| messageAuthorEmail | Email of the message author |
| likeCount | Number of message likes |
Report example:
"accessCode","meetingHost","hostEmail","messageTime","announcementText","messageText","messageAuthor","messageAuthorEmail","likeCount"
"142105833","Joe Admin","joe.admin@email.com","2021-12-08 18:37:02","Welcome to today's session, please send in your questions here. We will do our best to answer as many as we can.","","","",""
"142105833","Joe Admin","joe.admin@email.com","2021-12-09 14:32:28","","Thank you for this session","David Davidson","david.davidson@email.com","2"
"142105833","Joe Admin","joe.admin@email.com","2021-12-09 15:48:25","","Can you tell me more about this EBITDA thing?","Shirley","shirley@email.com","4"
"142105833","Joe Admin","joe.admin@email.com","2021-12-09 15:48:15","","What time is lunch?","Edward Snowman","edward.snowman@email.com","1"
Type ID: messages
Version: v1 (contains information about deprecated host messages)
| Column title | Description |
| accessCode | Session ID |
| meetingHost | Name of the meeting host |
| messageText | Message text |
| messageTime | Time when message was received in time format: YYYY-MM-DD HH:MM:SS |
| hostMessage | Whether this message was created by the meeting host or not ('YES' or 'NO') |
Report example:
"accessCode","meetingHost","messageText","messageTime","hostMessage"
"142105833","Joe Admin","Welcome to today's session, please send in your questions here. We will do our best to answer as many as we can.","2021-12-22 18:37:02","YES"
"142105833","David Davidson","Thank you for this session","2021-12-09 14:32:28","NO"
"142105833","Shirley","Can you tell me more about this EBITDA thing?","2021-12-09 15:48:25","NO"
"142105833","Edward Snowman","What time is lunch?","2021-12-09 15:48:15","NO"