Get active/inactive host reports

A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.
The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.
The Inactive Hosts report pulls a list of users who were not active during a specific period of time.
Use this API to retrieve an active or inactive host report 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.
You can specify the type of report and date range using the query parameters.
Scopes: report:read:admin

Rate Limit Label: Heavy
Prerequisites:

Pro or higher plan.

{ "from": "2019-08-14", "page_count": 1, "page_number": 1, "page_size": 30, "to": "2019-09-14", "total_meeting_minutes": 10, "total_meetings": 2, "total_participants": 10, "total_records": 3, "users": [ { "create_time": "2019-09-13T16:20:30Z", "dept": "", "email": "reag12343@gmail.com", "id": "BzBAAAAAAAfprg", "last_client_version": "4.4.1242.0623(win)", "last_login_time": "2019-09-13T16:21:40Z", "meeting_minutes": 5, "meetings": 1, "participants": 5, "type": 1, "user_name": "cbcvbvcbvbc" }, { "create_time": "2019-07-23T00:27:34Z", "dept": "Business", "email": "mynewemailgoog@gmail.com", "id": "0CAAAAA6jxcA", "last_client_version": "4.4.1242.0623(win)", "last_login_time": "2019-07-23T00:28:00Z", "meeting_minutes": 0, "meetings": 0, "participants": 0, "type": 1, "user_name": "xgdzgdfg" } ] }

请求参数

Query 参数

type

enum<string>

可选

Active or inactive hosts.
active - Active hosts.
inactive - Inactive hosts.

枚举值:

activeinactive

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

默认值:

page_number

integer

可选

The page number of the current page in the returned records.

默认值:

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.

返回响应

🟢200**HTTP Status Code:** `200`<br> Active or inactive hosts report returned.<br> This is only available for paid account: {accountId}.

application/json

Body

from

string <date>

可选

Start date for this report.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

The page number of the current results.

默认值:

page_size

integer

可选

The number of records returned with a single API call.

<= 300

默认值:

string <date>

可选

End date for this report.

total_records

integer

可选

The total number of all the records available across pages.

total_meeting_minutes

integer

可选

Number of meeting minutes for this range.

total_meetings

integer

可选

Number of meetings for this range.

total_participants

integer

可选

Number of participants for this range.

users

array [object {9}]

可选

Array of user objects.

custom_attributes

object

可选

Custom attribute(s) that have been assigned to the user.

dept

string

可选

User department.

string

可选

User email.

string <uuid>

User ID.

可选

meeting_minutes

integer

可选

Number of meeting minutes for user.

meetings

integer

可选

Number of meetings for user.

participants

integer

可选

Number of participants in meetings for user.

type

integer

可选

User type.

user_name

string

可选

User display name.