Chilkat Online Tools

Python / Zoom API / Get webinar detail reports

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

sbResponseBody = chilkat2.StringBuilder()
success = http.QuickGetSb("https://api.zoom.us/v2/report/webinars/:webinarId",sbResponseBody)
if (success == False):
    print(http.LastErrorText)
    sys.exit()

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = http.LastStatus
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.LastHeader)
    print("Failed.")
    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "uuid": "urn4fe6caeb98",
#   "id": 51788617,
#   "type": 5,
#   "topic": "My Health Webinar",
#   "user_name": "Utfdfdget",
#   "user_email": "example@example.com",
#   "start_time": "2019-11-18T03:15:00.056Z",
#   "end_time": "2019-11-18T03:15:20.056Z",
#   "duration": 20,
#   "total_minutes": 10,
#   "participants_count": 13,
#   "tracking_fields": [
#     {
#       "field": "Webinar Purpose",
#       "value": "Health awareness"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

uuid = jResp.StringOf("uuid")
id = jResp.IntOf("id")
v_type = jResp.IntOf("type")
topic = jResp.StringOf("topic")
user_name = jResp.StringOf("user_name")
user_email = jResp.StringOf("user_email")
start_time = jResp.StringOf("start_time")
end_time = jResp.StringOf("end_time")
duration = jResp.IntOf("duration")
total_minutes = jResp.IntOf("total_minutes")
participants_count = jResp.IntOf("participants_count")
i = 0
count_i = jResp.SizeOfArray("tracking_fields")
while i < count_i :
    jResp.I = i
    field = jResp.StringOf("tracking_fields[i].field")
    value = jResp.StringOf("tracking_fields[i].value")
    i = i + 1

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/webinars/:webinarId

Postman Collection Item JSON

{
  "name": "Get webinar detail reports",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/report/webinars/:webinarId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "report",
        "webinars",
        ":webinarId"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
        }
      ]
    },
    "description": "Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.  <br><br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or higher plan with Webinar add-on."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nWebinar details returned.<br>\nThis is only available for paid account:{accountId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"uuid\": \"urn4fe6caeb98\",\n \"id\": 51788617,\n \"type\": 5,\n \"topic\": \"My Health Webinar\",\n \"user_name\": \"Utfdfdget\",\n \"user_email\": \"example@example.com\",\n \"start_time\": \"2019-11-18T03:15:00.056Z\",\n \"end_time\": \"2019-11-18T03:15:20.056Z\",\n \"duration\": 20,\n \"total_minutes\": 10,\n \"participants_count\": 13,\n \"tracking_fields\": [\n  {\n   \"field\": \"Webinar Purpose\",\n   \"value\": \"Health awareness\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `300`<br>\nCan not access webinar information:{webinarId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nWebinar ID not found.<br>\n**Error Code:** `3001`<br>\nMeeting  {meetingId} not found or has expired.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}