Get webinar report - Zoho Webinar

Note: This task is applicable to all services except Zoho Creator.

Overview:

This task is used to get a report of a webinar in Zoho Webinar.

This task is based on Zoho Webinar API: Poll report, Attendee report and Question report.

Syntax:

<variable> = zoho.webinar.getWebinarReports(<portal_id>, <webinar_key>, <module>, <query_params>, <connection>);

where:

ParamsData typeDescription
<variable>KEY-VALUESpecifies the variable that will hold the response returned by Zoho Webinar.
<portal_Id>NUMBER

Specifies the unique portal identifier where webinar reports will be fetched from.

Note: Portal_Id can be fetched in the following ways.

  • From the URL of the application while accessing it. The URL is in the format webinar.zoho.com/webinar/portal_Id/department_Id/home
  • Get portal ID from Zoho Webinar API, where ZSOID represents the portal ID.
<webinar_key>NUMBERSpecifies the unique key identifier of the webinar to fetch reports from.
<module>TEXTSpecifies the supported modules: poll, questions, attendees.
<query_params>KEY-VALUESpecifies the additional query filters such as pagination or search parameters.
<connection>TEXT

Specifies the link of the Zoho Webinar connection.

Required scope for this connection: ZohoWebinar.report.READ

Example: The following script fetches a polls report using webinar key in Zoho Webinar.

Poll

queryparams = Map();
queryparams.put("index",1);
queryparams.put("count", 20);
queryparams.put("category", 2);
queryparams.put("instanceId","645551000000038094");
response = zoho.webinar.getWebinarReports(86367739,1049243583,"poll",queryparams,"webinar");

where:

response
Is the KEY-VALUE returned by Zoho Webinar. It represents the webinar details.
"86367739"
Is the NUMBER unique portal identifier where the webinar will be updated.
"1049243583"
Is the NUMBER that specifies the webinar key used to fetch the poll report.
"poll"
Is the category of the report such as polls report, attendees report, and questions reports.
query_params

Is the KEY-VALUE that specifies the additional query filters such as pagination or search parameters.

Available category for polls: 1 > Star rating; 2 > Single choice; 3 > Multiple choice

"webinar"
Is the TEXT that represents the name of the connection.

Questions

queryparams = Map();
queryparams.put("index",1);
queryparams.put("count", 2);
queryparams.put("instanceId","645551000000038094");
rsponse = zoho.webinar.getWebinarReports(86367739,1049243583,"questions",queryparams,"webinar");

Attendees

queryparams = Map();
queryparams.put("index",1);
queryparams.put("count", 2);
queryparams.put("instanceId","645551000000038094");
rsponse = zoho.webinar.getWebinarReports(86367739,1049243583,"attendees",queryparams,"webinar");

Sample response

The success response returned is of the following format.

Success response: Polls

{
  "meta": {
    "count": 1
  },
  "pollData": [
    {
      "question": "sdf",
      "totalVotes": "1",
      "pollId": "645551000000038154",
      "percentage": 33.33,
      "options": [
        {
          "percentage": 0,
          "count": "0",
          "index": "1",
          "id": "645551000000038156",
          "text": "sdf"
        },
        {
          "percentage": 100,
          "count": "1",
          "index": "2",
          "id": "645551000000038158",
          "text": "sdfsdf"
        }
      ],
      "type": "1",
      "category": "2"
    }
  ]
}
 

Success response: Questions

{
  "meta": {
    "count": 9
  },
  "questions": [
    {
      "questionId": "645551000000038181",
      "question": "sdf",
      "projectionStatus": "NOT_PROJECTED",
      "registerId": "645551000000038166",
      "questionerName": "prahana prahana test",
      "isAnswered": false,
      "questionedBy": "prahana.m+11@zohotest.com",
      "questionedById": "645551000000038171",
      "questionType": "private",
      "questionTime": "1765350901117"
    },
    {
      "questionId": "645551000000038183",
      "question": "sdf",
      "projectionStatus": "NOT_PROJECTED",
      "registerId": "645551000000038166",
      "questionerName": "prahana prahana test",
      "isAnswered": false,
      "questionedBy": "prahana.m+11@zohotest.com",
      "questionedById": "645551000000038171",
      "questionType": "private",
      "questionTime": "1765350901468"
    }
  ]
}
 

Sample response: Attendees

{
  "meta": {
    "count": 3
  },
  "attendees": [
    {
      "approvalStatus": "1",
      "lastName": "prahana test",
      "registerKey": "255f562f597d1f72a6d6336042a76bcb405a80c78f9c07b0ae75e63a89e018fa",
      "leftTimeInMillis": 1765350944143,
      "questions": "4",
      "polls": "1",
      "registeredTimeInMillis": 1765348800000,
      "userName": "prahana prahana test",
      "duration": 40120,
      "firstName": "prahana",
      "registeredTime": "Dec 10, 2025 12:10 PM IST",
      "registerId": "645551000000038116",
      "joinedTime": "Dec 10, 2025 12:45 PM IST",
      "joinedTimeInMillis": 1765350904023,
      "leftTime": "Dec 10, 2025 12:45 PM IST",
      "countryName": "unknown",
      "email": "prahana.m+11@sd.com"
    },
    {
      "approvalStatus": "1",
      "lastName": "prahana test",
      "registerKey": "59f77e5523289d89fdb31d265a8e1477b5bfd0a7ce8d576837541723a0c9f654",
      "leftTimeInMillis": 1765348894937,
      "questions": "0",
      "polls": "0",
      "registeredTimeInMillis": 1765348800000,
      "userName": "prahana prahana test",
      "duration": 37320,
      "firstName": "prahana",
      "registeredTime": "Dec 10, 2025 12:10 PM IST",
      "registerId": "645551000000038133",
      "joinedTime": "Dec 10, 2025 12:10 PM IST",
      "joinedTimeInMillis": 1765348857617,
      "leftTime": "Dec 10, 2025 12:11 PM IST",
      "countryName": "unknown",
      "email": "prahana.m+11@sdfs.com"
    }
  ]
}
 

Failure response

{
  "error": {
    "errorCode": 4000,
    "message": "The meeting key is invalid.",
    "key": "INVALID_MEETING_KEY"
  }
}