Get meeting reports

Retrieve report on a past meeting for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months.

Meetings will only be returned in the response if the meeting has two or more unique participants.

Scopes: report:read:admin

Rate Limit Label: Heavy
Prerequisites:

Pro or higher plan.

{ "from": "2019-07-14", "to": "2019-08-14", "page_count": 1, "page_size": 30, "total_records": 9, "next_page_token": "", "meetings": [ { "uuid": "/lqsAAAA5VBBBw==", "id": 12345, "host_id": "gdfg3434dsssfss", "type": 2, "topic": "MyTestMeetings", "user_name": "Prashant Bhandari", "user_email": "pb@hjdskfhds.fdskhfhds", "start_time": "2019-07-15T23:24:52Z", "end_time": "2019-07-15T23:30:19Z", "duration": 6, "total_minutes": 11, "participants_count": 2 }, { "uuid": "411bbbbbbcVyw==", "id": 000000, "host_id": "gdfg3434dsssfss", "type": 2, "topic": "My Meeting", "user_name": "Raju Khanal", "user_email": "srhkdjfh@jh.fsadghjm", "start_time": "2019-07-16T17:14:39Z", "end_time": "2019-07-16T17:26:20Z", "duration": 12, "total_minutes": 17, "participants_count": 2 } ] }

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query 参数

from

string <date>

必需

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.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

next_page_token

string

可选

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.

type

enum<string>

可选

The meeting types:
past - Past meetings.
pastOne - Past one user meetings.

枚举值:

pastpastOne

默认值:

past

返回响应

🟢200**HTTP Status Code:** `200` Active or inactive hosts report returned.

application/json

Body

Pagination Object.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

Deprecated: This field has been deprecated. Please use the "next_page_token" field for pagination instead of this field.

The page number of the current results.

默认值:

page_size

integer

可选

The number of records returned with a single API call.

<= 300

默认值:

total_records

integer

可选

The total number of all the records available across pages.

from

string <date>

可选

Start date for this report.

meetings

array [object {13}]

可选

Array of meeting objects.

custom_keys

array [object {2}]

可选

Custom keys and values assigned to the meeting.

<= 10 items

duration

integer

可选

Meeting duration.

end_time

string <date-time>

可选

Meeting end time.

integer

可选

Meeting ID: Unique identifier of the meeting in "long" format(represented as int64
data type in JSON), also known as the meeting number.

participants_count

integer

可选

Number of meeting participants.

source

string

可选

Indicates whether the meeting was created directly through Zoom or through an API request.

start_time

string <date-time>

可选

Meeting start time.

topic

string

可选

Meeting topic.

total_minutes

integer

可选

Sum of meeting minutes from all participants in the meeting.

type

integer

可选

Meeting Type:
1 - Instant Meeting
2 - Scheduled Meeting
3 - Recurring Meeting with no fixed time.
4 - This value is returned if the meeting was started using a Personal Meeting ID.
8 - Recurring Meeting with a fixed time.

user_email

string

可选

User email.

user_name

string

可选

User display name.

uuid

string <uuid>

可选

Meeting UUID. Each meeting instance will generate its own UUID(i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). Please double encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it.

string <date>

可选

End date for this report.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` This is only available for paid account:{accountId}. **Error Code:** `300` The next page token is invalid or expired.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1001` User {userId} not exist or not belong to this account.