Android / Zoom API / Get webinar detail reports
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkStringBuilder sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://api.zoom.us/v2/report/webinars/:webinarId",sbResponseBody);
if (success == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = http.get_LastStatus();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, http.lastHeader());
Log.i(TAG, "Failed.");
return;
}
// 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
String field;
String value;
String uuid = jResp.stringOf("uuid");
int id = jResp.IntOf("id");
int v_type = jResp.IntOf("type");
String topic = jResp.stringOf("topic");
String user_name = jResp.stringOf("user_name");
String user_email = jResp.stringOf("user_email");
String start_time = jResp.stringOf("start_time");
String end_time = jResp.stringOf("end_time");
int duration = jResp.IntOf("duration");
int total_minutes = jResp.IntOf("total_minutes");
int participants_count = jResp.IntOf("participants_count");
int i = 0;
int count_i = jResp.SizeOfArray("tracking_fields");
while (i < count_i) {
jResp.put_I(i);
field = jResp.stringOf("tracking_fields[i].field");
value = jResp.stringOf("tracking_fields[i].value");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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": ""
}
]
}