REST Report API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

The following API calls go over the creation of Reports through Zooms REST API calls.

Get daily report for one month, can only get daily report for recent 3 months.
Endpoint:

https://api.zoom.us/v1/report/getdailyreport

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&year=2016&month=1' https://api.zoom.us/v1/report/getdailyreport

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
<year>2013</year>
<month>5</month>
<dates>
		<date>
		<date>2013-05-01</date>
		<new_user>0</new_user>
		<meetings>0</meetings>
		<participants>0</participants>
		<meeting_minutes>0</meeting_minutes>
		</date>
		...
		<date>
		<date>2013-05-31</date>
		<new_user>0</new_user>
		<meetings>0</meetings>
		<participants>0</participants>
		<meeting_minutes>0</meeting_minutes>
		</date>
	</dates>
</result>

Response JSON:

{
 "year": 2013,
 "month": 5,
 "dates": [{
	 "meetings": 0,
	 "date": "2013-05-01",
	 "new_user": 0,
	 "participants": 0,
	 "meeting_minutes": 0
	 },
	 ...
	 {
	 "meetings": 0,
	 "date": "2013-05-31",
	 "new_user": 0,
	 "participants": 0,
	 "meeting_minutes": 0
 }]
}

Get account report for a specified period.

Note: We will report a maximum of one month. For example, if "from" is set to "2015-08-05" and "to" is "2015-10-10" we will adjust "from" to "2015-09-10"

Endpoint:

https://api.zoom.us/v1/report/getaccountreport

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/report/getaccountreport

Reponse XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
	<from>2013-5-19</from>
	<to>2013-5-20</to>
	<page_count>1</page_count>
	<page_number>1</page_number>
	<page_size>30</page_size>
	<total_records>5</total_records>
	<total_meetings>50</total_meetings>
	<total_participants>100</total_participants>
	<total_meeting_minutes>1000</total_meeting_minutes>
	<users>
		<user>
		<user_id>bNsPi5hCQ-qOzWn2EeCXJA</user_id>
		<email>john@sample.com</email>
		<type>2</type>
		<meetings>10</meetings>
		<participants>56</participants>
		<meeting_minutes>300</meeting_minutes>
		<last_client_version>1.0.18584.0225</last_client_version>
		<last_login_time>2013-02-11T08:18:09Z</last_login_time>
		</user>
		...
	</users>
</result>

Response JSON:

{
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 5,
"from": "2013-5-19",
"to": "2013-5-20",
"total_meetings": 50,
"total_participants": 100,
"total_meeting_minutes": 100,
"users": [
{
	"user_id": "bNsPi5hCQ-qOzWn2EeCXJA",
	"email": "john@sample.com",
	"type": 2,
	"meetings": 10,
	"participants": 56,
	"meeting_minutes": 300,
	"last_client_version": "1.0.18584.0225",
	"last_login_time": "2013-02-11T08:18:09Z"
	},
...
]
}

Get user report for a specified period.

Note: We will report a maximum of one month. For example, if "from" is set to "2015-08-05" and "to" is "2015-10-10" we will adjust "from" to "2015-09-10"


Endpoint:

https://api.zoom.us/v1/report/getuserreport

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&user_id=your_user_id&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/report/getuserreport


Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
	<from>2013-5-19</from>
	<to>2013-5-20</to>
	<page_count>1</page_count>
	<page_number>1</page_number>
	<page_size>30</page_size>
	<total_records>5</total_records>
	<meetings>
		<meeting>
		<number>111111111</number>
		<topic>meeting topic</topic>
		<start_time>2013-02-11T08:18:09Z</start_time>
		<end_time>2013-02-11T09:18:09Z</end_time>
		<duration>60</duration>
		<participants>
		<participant>
		<name>John</name>
		<join_time>2013-02-11T08:30:09Z</join_time>
		<leave_time>2013-02-11T08:50:09Z</leave_time>
		</participant>
		...
		</participants>
		</meeting>
		...
	</meetings>
</result>

Response JSON:

{
 "page_count": 1,
 "page_number": 1,
 "page_size": 30,
 "total_records": 5,
 "from": "2013-5-19",
 "to": "2013-5-20",
 "meetings": [
	 {
	 "number": 111111111,
	 "topic": "meeting topic",
	 "start_time": "2013-02-11T08:18:09Z",
	 "end_time": "2013-02-11T09:18:09Z",
	 "duration": 60,
	 "participants": [
	 {
		 "name": "John",
		 "join_time": "2013-02-11T08:30:09Z",
		 "leave_time": "2013-02-11T08:50:09Z"
	 },
	 ...
	 ]
	 },
 ...
 ]
}

Get audio report for a specified period.

Note: We will report a maximum of one month. For example, if "from" is set to "2015-08-05" and "to" is "2015-10-10" we will adjust "from" to "2015-09-10"

Endpoint:

https://api.zoom.us/v1/report/getaudioreport

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/report/getaudioreport

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2016-01-08</from>
    <to>2016-01-21</to>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>1</total_records>
    <telephony_usage>
        <audio>
            <meeting_id>2932547621</meeting_id>
            <phone_number>+86 8208</phone_number>
            <type>call-out</type>
            <host_name>test</host_name>
            <host_email>zoom.test@zoom.us</host_email>
            <department></department>
            <start_time>2016-01-12T02:25:34Z</start_time>
            <end_time>2016-01-12T02:26:48Z</end_time>
            <duration>2</duration>
            <total>0.12</total>
        </audio>
</result>

Response JSON:

{
"from": "2016-01-08",
"to": "2016-01-21",
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"telephony_usage": [{
    "meeting_id": 2932547621,
    "phone_number": "+86 8208",
    "type": "call-out",
    "host_name": "test",
    "host_email": "zoom.test@zoom.us",
    "department": "",
    "start_time": "2016-01-12T02:25:34Z",
    "end_time": "2016-01-12T02:26:48Z",
    "duration": 2,
    "total": 0.12
}]
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk