Powershell / Zoom API / Get upcoming events report
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("from","1989-05-07")
$queryParams.UpdateString("to","1989-05-07")
$queryParams.UpdateInt("page_size",30)
$queryParams.UpdateString("next_page_token","quis officia in reprehenderit")
$queryParams.UpdateString("type","all")
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$resp = $http.QuickRequestParams("GET","https://api.zoom.us/v2/report/upcoming_events",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "from": "2019-07-14",
# "to": "2019-08-14",
# "page_size": 30,
# "next_page_token": "token",
# "upcoming_events": [
# {
# "id": 12345,
# "start_time": "08/24/2021 16:00",
# "topic": "topic",
# "host_id": "host_id",
# "host_name": "Ming",
# "dept": "dept"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$from = $jResp.StringOf("from")
$v_to = $jResp.StringOf("to")
$page_size = $jResp.IntOf("page_size")
$next_page_token = $jResp.StringOf("next_page_token")
$i = 0
$count_i = $jResp.SizeOfArray("upcoming_events")
while ($i -lt $count_i) {
$jResp.I = $i
$id = $jResp.IntOf("upcoming_events[i].id")
$start_time = $jResp.StringOf("upcoming_events[i].start_time")
$topic = $jResp.StringOf("upcoming_events[i].topic")
$host_id = $jResp.StringOf("upcoming_events[i].host_id")
$host_name = $jResp.StringOf("upcoming_events[i].host_name")
$dept = $jResp.StringOf("upcoming_events[i].dept")
$i = $i + 1
}
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "type=all"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/upcoming_events
Postman Collection Item JSON
{
"name": "Get upcoming events report",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/upcoming_events?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"upcoming_events"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"key": "type",
"value": "all",
"description": "The type of event to query: \n* `meeting` — A meeting event. \n* `webinar` — A webinar event. \n* `all` — Both meeting and webinar events.\n\nThis value defaults to `all`."
}
]
},
"description": "Use this API to list upcoming meeting and/or webinar events within a specified period of time. The report's time range is limited to one month and must also be within the past six months.\n\n**Scopes:** `report:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\n\n**Prerequisites:** \n* A Pro or higher plan"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nUpcoming events report returned.<br>\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/upcoming_events?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"upcoming_events"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "type",
"value": "all"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-07-14\",\n \"to\": \"2019-08-14\",\n \"page_size\": 30,\n \"next_page_token\": \"token\",\n \"upcoming_events\": [\n {\n \"id\": 12345,\n \"start_time\": \"08/24/2021 16:00\",\n \"topic\": \"topic\",\n \"host_id\": \"host_id\",\n \"host_name\": \"Ming\",\n \"dept\": \"dept\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` <br> Bad Request <br> **Error Code:** `200` <br> This is only available for the paid account: {accountId} <br> **Error Code:** `300`<br> The next page token is invalid or expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/upcoming_events?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"upcoming_events"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "type",
"value": "all"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
