1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
use anyhow::Result;
use crate::Client;
pub struct Dashboards {
pub client: Client,
}
impl Dashboards {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Dashboards { client }
}
/**
* List meetings.
*
* This function performs a `GET` to the `/metrics/meetings` endpoint.
*
* List total live or past meetings that occurred during a specified period of time. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.<br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.<br>
* **Scopes:** `dashboard_meetings:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br><br>
* **Prerequisites:** <br>
* * Business or a higher plan.<br><br>
*
* **Parameters:**
*
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
* * `include_fields: crate::types::IncludeFields` -- Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response.
*/
pub async fn meeting(
&self,
type_: crate::types::DashboardMeetingsType,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
include_fields: crate::types::IncludeFields,
) -> Result<crate::types::DashboardMeetingsResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !include_fields.to_string().is_empty() {
query_args.push(("include_fields".to_string(), include_fields.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/meetings?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get meeting details.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}` endpoint.
*
* Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.<br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. <br>
* **Scopes:** `dashboard_meetings:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:** <br>
* * Business or a higher plan.
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
*/
pub async fn meeting_detail(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
) -> Result<crate::types::MeetingMetric> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List meeting participants.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants` endpoint.
*
* Get a list of participants from live or past meetings.<br><br>
* If you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`. <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.
*
* **Scopes:** `dashboard_meetings:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:** Business or a higher plan.
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
* * `include_fields: crate::types::DashboardMeetingParticipantsIncludeFields` -- Provide `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a [meeting registrant](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrants). This is not supported for `live` meeting types.
*/
pub async fn meeting_participant(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
page_size: i64,
next_page_token: &str,
include_fields: crate::types::DashboardMeetingParticipantsIncludeFields,
) -> Result<crate::types::DashboardMeetingParticipantsResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_fields.to_string().is_empty() {
query_args.push(("include_fields".to_string(), include_fields.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get meeting participant QoS.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants/{participantId}/qos` endpoint.
*
* Use this API to retrieve the quality of service (QoS) for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.
*
* This API will **not** return data if there is no data being sent or received at the time of request.
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> When the sender sends its data, a timestamp is attached to the sender’s data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.</p>
*
* **Scopes:** `dashboard_meetings:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `participant_id: &str` -- User's first name.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
*/
pub async fn meeting_participant_qo(
&self,
meeting_id: &str,
participant_id: &str,
type_: crate::types::DashboardMeetingsType,
) -> Result<crate::types::ParticipantQos> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants/{}/qos?{}",
crate::progenitor_support::encode_path(meeting_id),
crate::progenitor_support::encode_path(participant_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List meeting participants QoS.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants/qos` endpoint.
*
* Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.<br>If you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.<br> <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.<br><br>
* **Scopes:** `dashboard_meetings:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:** <br>
* * Business or a higher plan.
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `page_size: i64` -- The number of items returned per page.
* * `next_page_token: &str` -- 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.
*/
pub async fn meeting_participants_qo(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants/qos?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get sharing/recording details.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants/sharing` endpoint.
*
* Retrieve the sharing and recording details of participants from live or past meetings.<br>
* **Scopes:** `dashboard_meetings:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:** <br>
* * Business or a higher plan.
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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 exceed the current page size. The expiration period for this token is 15 minutes.
*/
pub async fn meeting_participant_share(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardMeetingParticipantShareResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants/sharing?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List webinars.
*
* This function performs a `GET` to the `/metrics/webinars` endpoint.
*
* List all the live or past webinars from a specified period of time. <br><br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Webinar add-on.
*
*
*
*
* **Parameters:**
*
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
*/
pub async fn webinar(
&self,
type_: crate::types::DashboardWebinarsType,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardWebinarsResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/webinars?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get webinar details.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}` endpoint.
*
* Retrieve details from live or past webinars.<br><br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Webinar add-on.
*
*
*
* **Parameters:**
*
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
*/
pub async fn webinar_detail(
&self,
webinar_id: &str,
type_: crate::types::DashboardWebinarsType,
) -> Result<crate::types::Webinars> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get webinar participants.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants` endpoint.
*
* Retrieve details on participants from live or past webinars.<br><br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Webinar add-on.
*
*
*
* **Parameters:**
*
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
* * `include_fields: crate::types::DashboardMeetingParticipantsIncludeFields` -- Provide `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a [meeting registrant](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrants). This is not supported for `live` meeting types.
*/
pub async fn webinar_participant(
&self,
webinar_id: &str,
type_: crate::types::DashboardWebinarsType,
page_size: i64,
next_page_token: &str,
include_fields: crate::types::DashboardMeetingParticipantsIncludeFields,
) -> Result<crate::types::DashboardWebinarParticipantsResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_fields.to_string().is_empty() {
query_args.push(("include_fields".to_string(), include_fields.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get webinar participant QoS.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants/{participantId}/qos` endpoint.
*
* Retrieve details on the quality of service that participants from live or past webinars recieved.<br>This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.<br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` <br>
* **Prerequisites:** <br>
* * Business, Education or API Plan with Zoom Rooms set up.
*
*
* **Parameters:**
*
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `participant_id: &str` -- User's first name.
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
*/
pub async fn webinar_participant_qo(
&self,
webinar_id: &str,
participant_id: &str,
type_: crate::types::DashboardWebinarsType,
) -> Result<crate::types::ParticipantQos> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants/{}/qos?{}",
crate::progenitor_support::encode_path(webinar_id),
crate::progenitor_support::encode_path(participant_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List webinar participant QoS.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants/qos` endpoint.
*
* Retrieve a list of participants from live or past webinars and the quality of service they received.<br>This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.<br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:**
* * Business, Education or API Plan with Webinar add-on.
*
*
*
* **Parameters:**
*
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
* * `page_size: i64` -- The number of items returned per page.
* * `next_page_token: &str` -- 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.
*/
pub async fn webinar_participants_qo(
&self,
webinar_id: &str,
type_: crate::types::DashboardWebinarsType,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants/qos?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get sharing/recording details.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants/sharing` endpoint.
*
* Retrieve the sharing and recording details of participants from live or past webinars. <br><br>
* **Scopes:** `dashboard_webinars:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` <br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Webinar add-on.
*
*
*
* **Parameters:**
*
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardWebinarsType` -- The webinar type.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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 exceed the current page size. The expiration period for this token is 15 minutes.
*/
pub async fn webinar_participant_share(
&self,
webinar_id: &str,
type_: crate::types::DashboardWebinarsType,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardMeetingParticipantShareResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants/sharing?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List Zoom Rooms.
*
* This function performs a `GET` to the `/metrics/zoomrooms` endpoint.
*
* List information on all Zoom Rooms in an account.<br><br>
* **Scopes:** `dashboard_zr:read:admin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Zoom Rooms set up.
*
*
*
*
* **Parameters:**
*
* * `page_size: i64` -- The number of records returned within a single API call.
* * `page_number: i64` -- The page number of the current page in the returned records.
* * `next_page_token: &str` -- 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.
*/
pub async fn zoom_room(
&self,
page_size: i64,
page_number: i64,
next_page_token: &str,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_number > 0 {
query_args.push(("page_number".to_string(), page_number.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/zoomrooms?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get Zoom Rooms details.
*
* This function performs a `GET` to the `/metrics/zoomrooms/{zoomroomId}` endpoint.
*
* The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room.
*
* Use this API to retrieve information on a specific room.<br><br>
* **Scopes:** `dashboard_zr:read:admin`<br> <br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`**Prerequisites:**<br>
* * Business, Education or API Plan with Zoom Rooms set up.
*
*
* **Parameters:**
*
* * `zoomroom_id: &str` -- User's first name.
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
*/
pub async fn zoom_room_dashboards(
&self,
zoomroom_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/zoomrooms/{}?{}",
crate::progenitor_support::encode_path(zoomroom_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get CRC port usage.
*
* This function performs a `GET` to the `/metrics/crc` endpoint.
*
* A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting.
*
* Use this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".</aside><br><br>
* **Prerequisites:**<br>
* * Business, Education or API Plan.
* * Room Connector must be enabled on the account.<br><br>
* **Scopes:** `dashboard_crc:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
*/
pub async fn crc(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/metrics/crc?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get IM metrics.
*
* This function performs a `GET` to the `/metrics/im` endpoint.
*
* Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat client.
*
* You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.<p style="background-color:#e1f5fe; color:#000000; padding:8px"><b>Deprecated:</b> We will completely deprecate this endpoint in a future release. You can continue using this endpoint to query data for messages sent <b>before</b> July 1, 2021.</br></br>To get metrics on chat messages sent <b>on and after</b> July 1, 2021, use the <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardchat">Get chat metrics API</a>.</p>
*
* **Scopes:** `dashboard_im:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`
*
* **Prerequisites:**
*
* * Business or a higher plan.
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
*/
pub async fn im(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardImResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/metrics/im?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get chat metrics.
*
* This function performs a `GET` to the `/metrics/chat` endpoint.
*
* Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) for how users are utilizing Zoom Chat to send messages.
*
* Use the `from` and `to` query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.
*
* > **Note:** To query chat metrics from July 1, 2021 and later, use this endpoint instead of the [Get IM metrics API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardim).
*
* **Scope:** `dashboard_im:read:admin`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`
*
* **Prerequisites:**
*
* * Business or a higher plan
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
*/
pub async fn chat(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardChatResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/metrics/chat?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List Zoom meetings client feedback.
*
* This function performs a `GET` to the `/metrics/client/feedback` endpoint.
*
* Retrieve survey results from [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.
*
* **Prerequisites:**
* * Business or higher account
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled.
*
* **Scope:** `account:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
*/
pub async fn client_feedback(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<crate::types::DashboardClientFeedbackResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/client/feedback?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get top 25 issues of Zoom Rooms.
*
* This function performs a `GET` to the `/metrics/zoomrooms/issues` endpoint.
*
* Get top 25 issues of Zoom Rooms.<br>
* **Scopes:** `dashboard_zr:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:**<br>
* * Business, Education or API Plan with Zoom Rooms set up.
*
*
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
*/
pub async fn zoom_room_issue(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/zoomrooms/issues?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get top 25 Zoom Rooms with issues.
*
* This function performs a `GET` to the `/metrics/issues/zoomrooms` endpoint.
*
* Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and "to" range should fall within the last six months.<br>
* **Scope:** `dashboard_home:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:**<br>
* * Business or a higher plan.
* * Zoom Room must be enabled in the account.
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
*/
pub async fn issue_zoom_room(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<crate::types::DashboardIssueZoomRoomResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/issues/zoomrooms?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get issues of Zoom Rooms.
*
* This function performs a `GET` to the `/metrics/issues/zoomrooms/{zoomroomId}` endpoint.
*
* Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount. <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.
*
* **Scope:** `dashboard_home:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
* **Prerequisites:** <br>
* * Business or a higher plan.
* * Zoom Room must be enabled in the account.
*
* **Parameters:**
*
* * `zoomroom_id: &str` -- User's first name.
* * `from: chrono::NaiveDate` -- 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: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
*/
pub async fn issue_detail_zoom_room(
&self,
zoomroom_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardIssueDetailZoomRoomResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/issues/zoomrooms/{}?{}",
crate::progenitor_support::encode_path(zoomroom_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get zoom meetings client feedback.
*
* This function performs a `GET` to the `/metrics/client/feedback/{feedbackId}` endpoint.
*
* Retrieve detailed information on a [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.
*
* **Prerequisites:**
* * Business or higher account
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled.
*
* **Scope:** `dashboard_home:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* `
*
* **Parameters:**
*
* * `feedback_id: &str` -- User's first name.
* * `from: chrono::NaiveDate` -- Start Date.
* * `to: chrono::NaiveDate` -- Start Date.
* * `page_size: i64` -- Account seats.
* * `next_page_token: &str` -- User's first name.
*/
pub async fn client_feedback_detail(
&self,
feedback_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<crate::types::DashboardClientFeedbackDetailResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/client/feedback/{}?{}",
crate::progenitor_support::encode_path(feedback_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List client meeting satisfaction.
*
* This function performs a `GET` to the `/metrics/client/satisfaction` endpoint.
*
* If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months.
*
* To get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [Get Zoom Meetings Client Feedback API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).<br>
* **Scopes:** `dashboard:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- The start date for the query in “yyyy-mm-dd” format. .
* * `to: chrono::NaiveDate` -- The end date for the query in “yyyy-mm-dd” format. .
*/
pub async fn list_meeting_satisfaction(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<crate::types::ListMeetingSatisfactionResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/metrics/client/satisfaction?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List call logs.
*
* This function performs a `GET` to the `/phone/metrics/call_logs` endpoint.
*
* Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
*
* Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.
*
* **Prerequisites:**
* * Business, or Education account
* * Zoom Phone license <br><br>
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`<br>
* **Rate Limit Label:** `Heavy`
*
* **Parameters:**
*
* * `from: &str` -- Start date for the report in `yyyy-mm-dd` format. Specify a 30 day range using the `from` and `to` parameters as the response provides a maximum of a month worth of data per API request.
* * `to: &str` -- End date for the report in `yyyy-mm-dd` format.
* * `site_id: &str` -- Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
* * `quality_type: &str` -- Filter call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. <br><br>The value of this field can be one of the following:<br>
* * `good`: Retrieve call logs of the call(s) with good quality of voice.<br>
* * `bad`: Retrieve call logs of the call(s) with good quality of voice.<br>
* * `all`: Retrieve all call logs without filtering by voice quality.
*
*
*
* .
* * `page_size: i64` -- The number of records returned within a single call.
* * `next_page_token: &str` -- 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.
*/
pub async fn list_call_logs_metrics(
&self,
from: &str,
to: &str,
site_id: &str,
quality_type: &str,
page_size: i64,
next_page_token: &str,
) -> Result<Vec<crate::types::ListCallLogsMetricsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !quality_type.is_empty() {
query_args.push(("quality_type".to_string(), quality_type.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/phone/metrics/call_logs?{}", query_), None);
let resp: crate::types::ListCallLogsMetricsResponseData = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(resp.call_logs.to_vec())
}
/**
* List call logs.
*
* This function performs a `GET` to the `/phone/metrics/call_logs` endpoint.
*
* As opposed to `list_call_logs_metrics`, this function returns all the pages of the request at once.
*
* Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
*
* Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.
*
* **Prerequisites:**
* * Business, or Education account
* * Zoom Phone license <br><br>
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`<br>
* **Rate Limit Label:** `Heavy`
*/
pub async fn list_all_call_logs_metrics(
&self,
from: &str,
to: &str,
site_id: &str,
quality_type: &str,
) -> Result<Vec<crate::types::ListCallLogsMetricsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !quality_type.is_empty() {
query_args.push(("quality_type".to_string(), quality_type.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/phone/metrics/call_logs?{}", query_), None);
let mut resp: crate::types::ListCallLogsMetricsResponseData = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut call_logs = resp.call_logs;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
resp = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
call_logs.append(&mut resp.call_logs);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(call_logs)
}
/**
* Get call details from call log.
*
* This function performs a `GET` to the `/phone/metrics/call_logs/{call_id}` endpoint.
*
* Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
*
* Use this API to list call log details of a specific call.
*
* **Prerequisites:**
* * Business, or Education account
* * Zoom Phone license <br><br>
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`<br>
* **Rate Limit Label:** `Light`
*
*
* **Parameters:**
*
* * `call_id: &str` -- Unique identifier of the phone call. The value of this field can be retrieved from [List Call Logs]() API.
*/
pub async fn get_call_log_metrics_details(
&self,
call_id: &str,
) -> Result<crate::types::ListCallLogsMetricsResponse> {
let url = self.client.url(
&format!(
"/phone/metrics/call_logs/{}",
crate::progenitor_support::encode_path(call_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get call QoS.
*
* This function performs a `GET` to the `/phone/metrics/call_logs/{callId}/qos` endpoint.
*
* Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account.
*
* **Prerequisites:**
* * Business, or Education account
* * Zoom Phone license <br><br>
* **Scopes:** `phone:read:admin`, `phone:write:admin`<br>
* **Rate Limit Label:** `Light`
*
* **Parameters:**
*
* * `call_id: &str` -- Unique identifier of the call.
*/
pub async fn get_call_qo(&self, call_id: &str) -> Result<crate::types::GetCallQoSResponse> {
let url = self.client.url(
&format!(
"/phone/metrics/call_logs/{}/qos",
crate::progenitor_support::encode_path(call_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get post meeting feedback.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants/satisfaction` endpoint.
*
* When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020.
*
* **Prerequisites:**
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.
* * The user making the API request must be enrolled in a Business or a higher plan.
*
* <br> **Scope:** `dashboard_meetings:read:admiin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `next_page_token: &str` -- 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.
* * `page_size: i64` -- The number of records returned within a single API call.
*/
pub async fn participant_feedback(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::ParticipantFeedbackResponseParticipants>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants/satisfaction?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
let resp: crate::types::ParticipantFeedbackResponse = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(resp.participants.to_vec())
}
/**
* Get post meeting feedback.
*
* This function performs a `GET` to the `/metrics/meetings/{meetingId}/participants/satisfaction` endpoint.
*
* As opposed to `participant_feedback`, this function returns all the pages of the request at once.
*
* When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020.
*
* **Prerequisites:**
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.
* * The user making the API request must be enrolled in a Business or a higher plan.
*
* <br> **Scope:** `dashboard_meetings:read:admiin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
*/
pub async fn get_all_participant_feedback(
&self,
meeting_id: &str,
type_: crate::types::DashboardMeetingsType,
) -> Result<Vec<crate::types::ParticipantFeedbackResponseParticipants>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/meetings/{}/participants/satisfaction?{}",
crate::progenitor_support::encode_path(meeting_id),
query_
),
None,
);
let mut resp: crate::types::ParticipantFeedbackResponse = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut participants = resp.participants;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
resp = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
participants.append(&mut resp.participants);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(participants)
}
/**
* Get post webinar feedback.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants/satisfaction` endpoint.
*
* When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020.
*
* **Prerequisites:**
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.
* * The user making the API request must be enrolled in a Business or a higher plan.
*
*
* <br> **Scope:** `dashboard_webinars:read:admin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
*
* **Parameters:**
*
* * `type_: crate::types::DashboardMeetingsType` -- Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:<br> <br>`past` - Meeting that already occurred in the specified date range.<br>`pastOne` - Past meetings that were attended by only one user. <br>`live` - Live meetings.<br><br>
*
* If you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- 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.
* * `webinar_id: &str` -- The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
*/
pub async fn participant_webinar_feedback(
&self,
type_: crate::types::DashboardMeetingsType,
page_size: i64,
next_page_token: &str,
webinar_id: &str,
) -> Result<Vec<crate::types::ParticipantFeedbackResponseParticipants>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants/satisfaction?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
let resp: crate::types::ParticipantFeedbackResponse = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(resp.participants.to_vec())
}
/**
* Get post webinar feedback.
*
* This function performs a `GET` to the `/metrics/webinars/{webinarId}/participants/satisfaction` endpoint.
*
* As opposed to `participant_webinar_feedback`, this function returns all the pages of the request at once.
*
* When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020.
*
* **Prerequisites:**
* * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.
* * The user making the API request must be enrolled in a Business or a higher plan.
*
*
* <br> **Scope:** `dashboard_webinars:read:admin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
*/
pub async fn get_all_participant_webinar_feedback(
&self,
type_: crate::types::DashboardMeetingsType,
webinar_id: &str,
) -> Result<Vec<crate::types::ParticipantFeedbackResponseParticipants>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/metrics/webinars/{}/participants/satisfaction?{}",
crate::progenitor_support::encode_path(webinar_id),
query_
),
None,
);
let mut resp: crate::types::ParticipantFeedbackResponse = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut participants = resp.participants;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
resp = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
participants.append(&mut resp.participants);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(participants)
}
}