update readme list_monitors (#74)

whylabs · Dec 9, 2024 · c8d5e29 · c8d5e29
1 parent 3e92905
commit c8d5e29
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/whylabs_toolkit/helpers/README.md b/whylabs_toolkit/helpers/README.md
@@ -103,3 +103,20 @@ delete_monitor(
     monitor_id="monitor_id"
 )
 ```
+
+### List monitors
+
+To list all the monitor ids associated with a dataset-id, you can do:
+
+```python
+from whylabs_toolkit.helpers.monitor_helpers import list_monitors
+
+monitors = list_monitors(
+    org_id="org_id",
+    dataset_id="dataset_id"
+)
+
+print(monitors)
+
+# >> ["monitor-1", "monitor-2"]
+```