Get upcoming events report
GET {{baseUrl}}/report/upcoming_events?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=all&group_id=<string>
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.
Prerequisites:
- A Pro or higher plan
Scopes:
report:read:admin
Rate Limit Label
:
Heavy
Request Params
| Key | Datatype | Required | Description |
| from | string | | (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. |
| to | string | | (Required) End date. |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
| type | string | | The type of event to query.
meeting— A meeting event.webinar— A webinar event.all— Both meeting and webinar events.
This value defaults to all. |
| group_id | string | | The group ID. To get a group ID, use the List groups API.
Note: The API response will only contain meetings where the host is a member of the queried group ID. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"from":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_size":30,"to":"\u003cdate\u003e","upcoming_events":[{"dept":"\u003cstring\u003e","host_id":"\u003cstring\u003e","host_name":"\u003cstring\u003e","id":"\u003cstring\u003e","start_time":"\u003cstring\u003e","topic":"\u003cstring\u003e"},{"dept":"\u003cstring\u003e","host_id":"\u003cstring\u003e","host_name":"\u003cstring\u003e","id":"\u003cstring\u003e","start_time":"\u003cstring\u003e","topic":"\u003cstring\u003e"}]}