REST Dashboard 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 Dashboard Reports through Zooms REST API calls. Please see our Dashboard documentation for pre-requisites for Dashboard API access.

Get Live Meetings and past meetings for a specified period

Endpoint:

https://api.zoom.us/v1/metrics/meetings

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&type=2&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/metrics/meetings

Response XML: 

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2015-08-02</from>
    <to>2015-09-02</to>
    <page_count>2</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>49</total_records>
    <type>Past Meetings</type>
<meetings>
<meeting>
    <uuid>0BOM0JN1Q6Cz3dcPfEZOyQ==</uuid>
    <id>380428842</id>
    <host>zoom test</host>
    <email>zoom.test@zoom.us</email>
    <user_type>Pro</user_type>
    <start_time>2015-08-29T05:36:56Z</start_time>
    <end_time>2015-08-29T06:36:56Z </end_time>
    <duration>4 mins</duration>
    <participants>2</participants>
    <has_pstn>false</has_pstn>
    <has_voip>true</has_voip>
    <has_3rd_party_audio>false</ has_3rd_party_audio >
    <has_video>true</has_video>
    <has_screen_share>false</has_screen_share>
    <recording>0</recording>
  </meeting>
  ...
  <meeting>
       <uuid>zmN+GrTsRDOadzmzS5kqEg==</uuid>
       <id>826334854</id>
       <host>zoom test</host>
       <email>zoom.test@zoom.us</email>
       <user_type>Pro</user_type>
       <start_time>2015-08-30T05:36:56Z</start_time>
       <end_time>2015-08-30T06:36:56Z</end_time>
       <duration>11 mins</duration>
       <participants>6</participants>
       <has_pstn>false</ has_pstn>
       <has_voip>true</has_voip>
       <has_3rd_party_audio>false</has_3rd_party_audio>
       <has_video>true</has_video>
       <has_screen_share>false</has_screen_share>
       <recording>0</recording>
     </meeting>
</meetings>
</result>

Response JSON:

{ 
   "from": "2015-08-02",    
   "to": "2015-09-02",
   "page_count": 2,
   "page_number": 1,
   "page_size": 30,
   "total_records": 49,
   "type": "Past Meetings",
    "meetings": [{
      "uuid": "0BOM0JN1Q6Cz3dcPfEZOyQ==",
      "id": 380428842,
      "host": "zoom test",
      "email": "zoom.test@zoom.us",
      "user_type": "Pro",
      "start_time": "2015-08-29T05:36:56Z",
      "end_time": "2015-08-29T06:36:56Z",
      "duration": "4 mins",
      "participants": 2,
      "has_pstn": false,
      "has_voip": true,
      "has_3rd_party_audio": false,
      "has_video": true,
      "has_screen_share": false,
      "recording": 0
     },
     ...
     {
      "uuid": "zmN+GrTsRDOadzmzS5kqEg==",
      "id": 826334854,
      "host": "zoom test",
      "email": "zoom.test@zoom.us",
      "user_type": "Pro",
      "start_time": "2015-08-30T05:36:56Z",
      "end_time": "2015-08-30T06:36:56Z",
      "duration": "11 mins",
      "participants": 6,
      "has_pstn": false,
      "has_voip": true,
      "has_3rd_party_audio": false,
      "has_video": true,
      "has_screen_share": false,
      "recording": 0
    }]
}

Get live and past meeting details

Endpoint:

https://api.zoom.us/v1/metrics/meetingdetail

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&meeting_id=meeting_uuid&type=1' https://api.zoom.us/v1/metrics/meetingdetail

Response XML: 

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <uuid>0BOM0JN1Q6Cz3dcPfEZOyQ==</uuid>
    <id>380428842</id>
    <type>Past Meeting</type>
    <host>zoom test</host>
    <email>zoom.test@zoom.us</email>
    <user_type>Pro</user_type>
    <start_time>2015-08-30T05:36:56Z</start_time>
    <end_time>2015-08-30T06:36:56Z</end_time>
    <duration>4 mins</duration>
    <has_pstn>false</has_pstn>
    <has_voip>true</has_voip>
    <has_3rd_party_audio>false</has_3rd_party_audio>
    <has_video>true</has_video>
    <has_screen_share>false</has_screen_share>
    <recording>0</recording>
    <participants_count>2</participants_count>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <participants>
        <participant>
            <user_id>16778240</user_id>
            <user_name>zoom test1</user_name>
            <device>Windows</device>
            <ip_address>112.80.47.30</ip_address>
            <cn>CN</cn>
            <city>Nanjing</city>
            <join_time>2015-08-30T06:38:56Z</join_time>
            <leave_time>2015-08-30T06:41:56Z</leave_time>
        </participant>
…
        <participant>
            <user_id>16779264</user_id>
            <user_name>zoom test2 </user_name>
            <device>H.323/SIP</device>
            <ip_address>112.80.47.30</ip_address>
            <cn>CN</cn>
            <city>Nanjing</city>
            <join_time>2015-08-30T06:37:56Z</join_time>
            <leave_time>2015-08-30T06:40:56Z</leave_time>
        </participant>
    </participants>
</result>

Response JSON:

{
    "uuid": "0BOM0JN1Q6Cz3dcPfEZOyQ==",
    "id": 380428842,
    "type": "Past Meeting",
    "host": "zoom test",
    "email": "zoom.test@zoom.us",
    "user_type": "Pro",
    "start_time": "2015-08-30T05:36:56Z",
    "end_time": "2015-08-30T06:36:56Z",
    "duration": "4 mins",
    "has_pstn": false,
    "has_voip": true,
    "has_3rd_party_audio": false,
    "has_video": true,
    "has_screen_share": false,
    "recording": 0,
    "participants_count": 2,
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "participants": [{
        "user_id": "16778240",
        "user_name": "zoom test1",
        "device": "Windows",
        "ip_address": "112.80.47.30",
        "cn": "CN",
        "city": "Nanjing",
        "join_time": "2015-08-30T06:38:56Z",
        "leave_time": "2015-08-30T06:41:56Z"
  }, 
  …
  {
        "user_id": "16779264",
        "user_name": "zoom test2",
        "device": "H.323/SIP",
        "ip_address": "112.80.47.30",
        "cn": "CN",
        "city": "Nanjing",
        "join_time": "2015-08-30T06:37:56Z",
        "leave_time": "2015-08-30T06:40:56Z"
      }]
}

Get live webinars and past webinars for a specified period.
Endpoint:

https://api.zoom.us/v1/metrics/webinars

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&type=2&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/metrics/webinars

Response XML:

<result>
    <from>2015-08-02</from>
    <to>2015-09-02</to>
    <page_count>2</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
     <total_records>49</total_records>
    <type>Past Webinars</type>
<webinars>
<webinar>
    <uuid>0BOM0JN1Q6Cz3dcPfEZOyQ==</uuid>
    <id>380428842</id>
    <host>zoom test</host>
    <email>zoom.test@zoom.us</email>
    <user_type>Pro</user_type>
    <start_time>2015-08-29T05:36:56Z</start_time>
    <end_time>2015-08-29T06:36:56Z </end_time>
    <duration>4 mins</duration>
    <participants>2</participants>
    <has_pstn>false</has_pstn>
    <has_voip>true</has_voip>
    <has_3rd_party_audio>false</ has_3rd_party_audio >
    <has_video>true</has_video>
    <has_screen_share>false</has_screen_share>
    <recording>0</recording>
  </webinar>
  ...
  <webinar>
       <uuid>zmN+GrTsRDOadzmzS5kqEg==</uuid>
       <id>826334854</id>
       <host>zoom test</host>
       <email>zoom.test@zoom.us</email>
       <user_type>Pro</user_type>
       <start_time>2015-08-30T05:36:56Z</start_time>
       <end_time>2015-08-30T06:36:56Z</end_time>
       <duration>11 mins</duration>
       <participants>6</participants>
       <has_pstn>false</ has_pstn>
       <has_voip>true</has_voip>
       <has_3rd_party_audio>false</has_3rd_party_audio>
       <has_video>true</has_video>
       <has_screen_share>false</has_screen_share>
       <recording>0</recording>
     </webinar>
</webinars>
</result>

Response JSON:

{ 
   "from": "2015-08-02",    
   "to": "2015-09-02",
   "page_count": 2,
   "page_number": 1,
   "page_size": 30,
   "total_records": 49,
   "type": "Past Webinars",
    "meetings": [{
      "uuid": "0BOM0JN1Q6Cz3dcPfEZOyQ==",
      "id": 380428842,
      "host": "zoom test",
      "email": "zoom.test@zoom.us",
      "user_type": "Pro",
      "start_time": "2015-08-29T05:36:56Z",
      "end_time": "2015-08-29T06:36:56Z",
      "duration": "4 mins",
      "participants": 2,
      "has_pstn": false,
      "has_voip": true,
      "has_3rd_party_audio": false,
      "has_video": true,
      "has_screen_share": false,
      "recording": 0
     },
     ...
     {
      "uuid": "zmN+GrTsRDOadzmzS5kqEg==",
      "id": 826334854,
      "host": "zoom test",
      "email": "zoom.test@zoom.us",
      "user_type": "Pro",
      "start_time": "2015-08-30T05:36:56Z",
      "end_time": "2015-08-30T06:36:56Z",
      "duration": "11 mins",
      "participants": 6,
      "has_pstn": false,
      "has_voip": true,
      "has_3rd_party_audio": false,
      "has_video": true,
      "has_screen_share": false,
      "recording": 0
    }]
}

Description
Endpoint:

https://api.zoom.us/v1/metrics/webinardetail

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&meeting_id=webinar_uuid&type=1' https://api.zoom.us/v1/metrics/webinardetail

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <uuid>0BOM0JN1Q6Cz3dcPfEZOyQ==</uuid>
    <id>380428842</id>
    <type>Past Webinar</type>
    <host>zoom test</host>
    <email>zoom.test@zoom.us</email>
    <user_type>Pro</user_type>
    <start_time>2015-08-30T05:36:56Z</start_time>
    <end_time>2015-08-30T06:36:56Z</end_time>
    <duration>4 mins</duration>
    <has_pstn>false</has_pstn>
    <has_voip>true</has_voip>
    <has_3rd_party_audio>false</has_3rd_party_audio>
    <has_video>true</has_video>
    <has_screen_share>false</has_screen_share>
    <recording>0</recording>
    <participants_count>2</participants_count>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <participants>
        <participant>
            <user_id>16778240</user_id>
            <user_name>zoom test1</user_name>
            <device>Windows</device>
            <ip_address>112.80.47.30</ip_address>
            <cn>CN</cn>
            <city>Nanjing</city>
            <join_time>2015-08-30T06:38:56Z</join_time>
            <leave_time>2015-08-30T06:41:56Z</leave_time>
        </participant>
…
        <participant>
            <user_id>16779264</user_id>
            <user_name>zoom test2 </user_name>
            <device>H.323/SIP</device>
            <ip_address>112.80.47.30</ip_address>
            <cn>CN</cn>
            <city>Nanjing</city>
            <join_time>2015-08-30T06:37:56Z</join_time>
            <leave_time>2015-08-30T06:40:56Z</leave_time>
        </participant>
    </participants>
</result>

Response JSON:

{
    "uuid": "0BOM0JN1Q6Cz3dcPfEZOyQ==",
    "id": 380428842,
    "type": "Past Webinar",
    "host": "zoom test",
    "email": "zoom.test@zoom.us",
    "user_type": "Pro",
    "start_time": "2015-08-30T05:36:56Z",
    "end_time": "2015-08-30T06:36:56Z",
    "duration": "4 mins",
    "has_pstn": false,
    "has_voip": true,
    "has_3rd_party_audio": false,
    "has_video": true,
    "has_screen_share": false,
    "recording": 0,
    "participants_count": 2,
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "participants": [{
        "user_id": "16778240",
        "user_name": "zoom test1",
        "device": "Windows",
        "ip_address": "112.80.47.30",
        "cn": "CN",
        "city": "Nanjing",
        "join_time": "2015-08-30T06:38:56Z",
        "leave_time": "2015-08-30T06:41:56Z"
  }, 
  …
  {
        "user_id": "16779264",
        "user_name": "zoom test2",
        "device": "H.323/SIP",
        "ip_address": "112.80.47.30",
        "cn": "CN",
        "city": "Nanjing",
        "join_time": "2015-08-30T06:37:56Z",
        "leave_time": "2015-08-30T06:40:56Z"
      }]
}

Get the users quality of service in a Zoom Meeting

Endpoint:

https://api.zoom.us/v1/metrics/qos

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&meeting_id=meeting_uuid&type=1&user_id=user_id' https://api.zoom.us/v1/metrics/qos

Response XML: 

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <meeting_id>6hvcjEvfTi6jiI4FiKKL8w==</meeting_id>
    <user_id>16778240</user_id>
    <type>Past Meeting</type>
    <device>Mac</device>
    <ip_address>112.80.63.6</ip_address>
    <cn>CN</cn>
    <city>Nanjing</city>
    <version>3.5.35288.1217</version>
    <user_qos>
        <qos>
            <dateTime>2015-08-30T06:40:56Z</dateTime>
            <audio_input>
                <bitrate>29 kbps</bitrate>
                <latency>39 ms</latency>
                <jitter>11 ms</jitter>
                <avg_loss>2.5%</avg_loss>
                <max_loss>5.0%</max_loss>
            </audio_input>
            <audio_output>
                <bitrate></bitrate>
                <latency></latency>
                <jitter></jitter>
                <avg_loss></avg_loss>
                <max_loss></max_loss>
            </audio_output>
            <video_input>
                <bitrate>77 kbps</bitrate>
                <latency>84 ms</latency>
                <jitter>4 ms</jitter>
                <avg_loss>28.3%</avg_loss>
                <max_loss>28.3%</max_loss>
                <resolution>480*270</resolution>
                <frame_rate>3 fps</frame_rate>
            </video_input>
            <video_output>
                <bitrate></bitrate>
                <latency></latency>
                <jitter></jitter>
                <avg_loss></avg_loss>
                <max_loss></max_loss>
                <resolution></resolution>
                <frame_rate></frame_rate>
            </video_output>
            <as_input>
                <bitrate></bitrate>
                <latency></latency>
                <jitter></jitter>
                <avg_loss></avg_loss>
                <max_loss></max_loss>
                <resolution></resolution>
                <frame_rate></frame_rate>
            </as_input>
            <as_output>
                <bitrate></bitrate>
                <latency></latency>
                <jitter></jitter>
                <avg_loss></avg_loss>
                <max_loss></max_loss>
                <resolution></resolution>
                <frame_rate></frame_rate>
            </as_output>
        </qos>
    </user_qos>
</result>

Response JSON:

{
    "meeting_id": "6hvcjEvfTi6jiI4FiKKL8w==",
    "user_id": "16778240",
    "type": "Past Meeting",
    "device": "Mac",
    "ip_address": "112.80.63.6",
    "cn": "CN",
    "city": "Nanjing",
    "version": "3.5.35288.1217",
    "user_qos": [{
        "dateTime": "2015-08-30T06:40:56Z",
        "audio_input": {
            "bitrate": "29 kbps",
            "latency": "39 ms",
            "jitter": "11 ms",
            "avg_loss": "2.5%",
            "max_loss": "5.0%"
        },
        "audio_output": {
            "bitrate": "",
            "latency": "",
            "jitter": "",
            "avg_loss": "",
            "max_loss": ""
        },
        "video_input": {
            "bitrate": "77 kbps",
            "latency": "84 ms",
            "jitter": "4 ms",
            "avg_loss": "28.3%",
            "max_loss": "28.3%",
            "resolution": "480*270",
            "frame_rate": "3 fps"
        },
        "video_output": {
            "bitrate": "",
            "latency": "",
            "jitter": "",
            "avg_loss": "",
            "max_loss": "",
            "resolution": "",
            "frame_rate": ""
        },
        "as_input": {
            "bitrate": "",
            "latency": "",
            "jitter": "",
            "avg_loss": "",
            "max_loss": "",
            "resolution": "",
            "frame_rate": ""
        },
        "as_output": {
            "bitrate": "",
            "latency": "",
            "jitter": "",
            "avg_loss": "",
            "max_loss": "",
            "resolution": "",
            "frame_rate": ""
        }
    }]
}

List all Zoom Rooms on Zoom.
Endpoint:

https://api.zoom.us/v1/metrics/zoomrooms

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/metrics/zoomrooms

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>2</total_records>
    <zoom_rooms>
        <zoom_room>
            <id>VD6s71SCSI2KERCV4zXsbw</id>
            <room_name>zoom room1</room_name>
            <email>zoomroom1@zoom.us</email>
            <account_type>Work Email</account_type>
            <passcode>123</passcode>
            <status>Available</status>
            <messages>
                <last_started_time></last_started_time>
                <running_time></running_time>
                <selected_microphone></selected_microphone>
                <selected_speaker></selected_speaker>
                <selected_camera></selected_camera>
            </messages>
            <meeting_id></meeting_id>
        </zoom_room>
        <zoom_room>
            <id>u2hOfzCGRcuib5nx5ELXlQ</id>
            <room_name>zoom room2</room_name>
            <email>zoomroom2@zoom.us </email>
            <account_type>Work Email</account_type>
            <passcode>888</passcode>
            <status>Available</status>
            <messages>
                <last_started_time></last_started_time>
                <running_time></running_time>
                <selected_microphone></selected_microphone>
                <selected_speaker></selected_speaker>
                <selected_camera></selected_camera>
            </messages>
            <meeting_id></meeting_id>
        </zoom_room>
</zoom_rooms>
</result>

Response JSON:

{
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 2,
    "zoom_rooms": [{
        "id": "VD6s71SCSI2KERCV4zXsbw",
        "room_name": "zoom room1",
        "email": "zoomroom1@zoom.us",
        "account_type": "Work Email",
        "passcode": "123",
        "status": "Available",
        "messages": {
            "last_started_time": "",
            "running_time": "",
            "selected_microphone": "",
            "selected_speaker": "",
            "selected_camera": ""
        },
        "meeting_id": ""
    }, {
        "id": "u2hOfzCGRcuib5nx5ELXlQ",
        "room_name": "zoom room2",
        "email": "zoomroom2@zoom.us ",
        "account_type": "Work Email",
        "passcode": "888",
        "status": "Available",
        "messages": {
            "last_started_time": "",
            "running_time": "",
            "selected_microphone": "",
            "selected_speaker": "",
            "selected_camera": ""
        },
        "meeting_id": ""
    }]
}

Get a Zoom Room on Zoom via Zoom ID, return the Zoom Room info.
Endpoint:

https://api.zoom.us/v1/metrics/zoomroomdetail

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&room_id=room_uuid&from=2016-05-05&to=2016-06-05' https://api.zoom.us/v1/metrics/zoomroomdetail

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2016-04-12</from>
    <to>2016-04-13</to>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>1</total_records>
    <zoom_room>
        <id>VD6s71SCSI2KERCV4zXsbw</id>
        <room_name>zoom room</room_name>
        <email>zoomroom@zoom.us </email>
        <account_type>Work Email</account_type>
        <passcode>123</passcode>
        <status>Available</status>
        <messages>
            <last_started_time></last_started_time>
            <running_time></running_time>
            <selected_microphone></selected_microphone>
            <selected_speaker></selected_speaker>
            <selected_camera></selected_camera>
        </messages>
        <meeting_id></meeting_id>
    </zoom_room>
    <live_meeting>
        <uuid></uuid>
        <id>0</id>
        <host></host>
        <email></email>
        <user_type></user_type>
        <start_time></start_time>
        <end_time></end_time>
        <duration></duration>
        <participants>0</participants>
        <has_pstn>false</has_pstn>
        <has_voip>false</has_voip>
        <has_3rd_party_audio>false</has_3rd_party_audio>
        <has_video>false</has_video>
        <has_screen_share>false</has_screen_share>
        <recording>0</recording>
    </live_meeting>
<past_meetings>
    <meeting>
            <uuid>dxwefK9SQ+TsVkHpC2njw==</uuid>
            <id>226703246</id>
            <host></host>
            <email>zoomtest@zoom.us</email>
            <user_type></user_type>
            <start_time></start_time>
            <end_time></end_time>
            <duration></duration>
            <participants>1</participants>
            <has_pstn>false</has_pstn>
            <has_voip>false</has_voip>
            <has_3rd_party_audio>false</has_3rd_party_audio>
            <has_video>false</has_video>
            <has_screen_share>false</has_screen_share>
        <recording>0</recording>
    </meeting>
</past_meetings>
</result>

Response JSON:

{
    "from": "2016-04-12",
    "to": "2016-04-13",
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 1,
    "zoom_room": {
        "id": "VD6s71SCSI2KERCV4zXsbw",
        "room_name": "zoom room",
        "email": "zoomroom@zoom.us",
        "account_type": "Work Email",
        "passcode": "123",
        "status": "Available",
        "messages": {
            "last_started_time": "",
            "running_time": "",
            "selected_microphone": "",
            "selected_speaker": "",
            "selected_camera": ""
        },
        "meeting_id": ""
    },
    "live_meeting": {
        "uuid": "",
        "id": 0,
        "host": "",
        "email": "",
        "user_type": "",
        "start_time": "",
        "end_time": "",
        "duration": "",
        "participants": 0,
        "has_pstn": false,
        "has_voip": false,
        "has_3rd_party_audio": false,
        "has_video": false,
        "has_screen_share": false,
        "recording": 0
    },
    "past_meetings": [{
        "uuid": "dxwefK9SQ+TsVkHpC2njw==",
        "id": 226703246,
        "host": "",
        "email": "zoomtest@zoom.us",
        "user_type": "",
        "start_time": "",
        "end_time": "",
        "duration": "",
        "participants": 1,
        "has_pstn": false,
        "has_voip": false,
        "has_3rd_party_audio": false,
        "has_video": false,
        "has_screen_share": false,
        "recording": 0
    }]
}

Get CRC Port usage hour by hour for a specified time 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/metrics/crc

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/metrics/crc

Response XML: 

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2015-03-12</from>
    <to>2015-03-12</to>
    <crc_ports_usage>
        <crc_ports_day_usage>
            <date_time>2015-03-12</date_time>
            <crc_ports_hour_usage>
                <usage>
                    <hour>00</hour>
                    <max_usage>1</max_usage>
                    <total_usage>3</total_usage>
                </usage>
                <usage>
                    <hour>01</hour>
                    <max_usage>0</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>02</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>03</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>04</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>05</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>06</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>07</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>08</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>09</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>10</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>11</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>12</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>13</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>14</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>15</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>16</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>17</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>18</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>19</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>20</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>21</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>22</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
                <usage>
                    <hour>23</hour>
                    <max_usage>1</max_usage>
                    <total_usage>1</total_usage>
                </usage>
            </crc_ports_hour_usage>
        </crc_ports_day_usage>
    </crc_ports_usage>
</result>

Response JSON:

{
    "from": "2015-03-12",
    "to": "2015-03-12",
    "crc_ports_usage": [{
        "date_time": "2015-03-12",
        "crc_ports_hour_usage": [{
            "hour": "00",
            "max_usage": 1,
            "total_usage": 3
        }, {
            "hour": "01",
            "max_usage": 0,
            "total_usage": 1
        }, {
            "hour": "02",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "03",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "04",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "05",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "06",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "07",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "08",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "09",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "10",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "11",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "12",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "13",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "14",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "15",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "16",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "17",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "18",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "19",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "20",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "21",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "22",
            "max_usage": 1,
            "total_usage": 1
        }, {
            "hour": "23",
            "max_usage": 1,
            "total_usage": 1
        }]
    }]
}

Get statistics of Zoom IM
Endpoint:

https://api.zoom.us/v1/metrics/im

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/metrics/im

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <from>2016-04-12</from>
    <to>2016-04-13</to>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>10</total_records>
    <users>
        <user>
            <user_id>0juYftoHQjmxrjdigk8ppA</user_id>
            <user_name>zoom test1</user_name>
            <email>zoomtest@zoom.us</email>
            <total_send>0</total_send>
            <total_receive>0</total_receive>
            <group_send>0</group_send>
            <group_receive>0</group_receive>
            <calls_send>0</calls_send>
            <calls_receive>0</calls_receive>
            <files_send>0</files_send>
            <files_receive>0</files_receive>
            <images_send>0</images_send>
            <images_receive>0</images_receive>
            <voice_send>0</voice_send>
            <voice_receive>0</voice_receive>
            <videos_send>0</videos_send>
            <videos_receive>0</videos_receive>
            <emoji_send>0</emoji_send>
            <emoji_receive>0</emoji_receive>
        </user>
        ...
        <user>
            <user_id>-BrO-CExTHu2KondL2FDHw</user_id>
            <user_name>zoom test2</user_name>
            <email>zoomtest2@zoom.us</email>
            <total_send>0</total_send>
            <total_receive>0</total_receive>
            <group_send>0</group_send>
            <group_receive>0</group_receive>
            <calls_send>0</calls_send>
            <calls_receive>0</calls_receive>
            <files_send>0</files_send>
            <files_receive>0</files_receive>
            <images_send>0</images_send>
            <images_receive>0</images_receive>
            <voice_send>0</voice_send>
            <voice_receive>0</voice_receive>
            <videos_send>0</videos_send>
            <videos_receive>0</videos_receive>
            <emoji_send>0</emoji_send>
            <emoji_receive>0</emoji_receive>
        </user>
    </users>
</result>

Response JSON:

{
    "from": "2016-04-12",
    "to": "2016-04-13",
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 10,
    "users": [{
        "user_id": "0juYftoHQjmxrjdigk8ppA",
        "user_name": "zoom test1",
        "email": "zoomtest1@zoom.us",
        "total_send": 0,
        "total_receive": 0,
        "group_send": 0,
        "group_receive": 0,
        "calls_send": 0,
        "calls_receive": 0,
        "files_send": 0,
        "files_receive": 0,
        "images_send": 0,
        "images_receive": 0,
        "voice_send": 0,
        "voice_receive": 0,
        "videos_send": 0,
        "videos_receive": 0,
        "emoji_send": 0,
        "emoji_receive": 0
    }, 
    ...
    {
        "user_id": "-BrO-CExTHu2KondL2FDHw",
        "user_name": "zoom test2",
        "email": "zoomtest2@zoom.us",
        "total_send": 0,
        "total_receive": 0,
        "group_send": 0,
        "group_receive": 0,
        "calls_send": 0,
        "calls_receive": 0,
        "files_send": 0,
        "files_receive": 0,
        "images_send": 0,
        "images_receive": 0,
        "voice_send": 0,
        "voice_receive": 0,
        "videos_send": 0,
        "videos_receive": 0,
        "emoji_send": 0,
        "emoji_receive": 0
    }]
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk