diff --git a/docs/usage.rst b/docs/usage.rst index 5509517..5ce04df 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -53,7 +53,7 @@ Metrics Metric name format ~~~~~~~~~~~ -All metric names must start with a letter or number (A-Za-z0-9) and can contain '.', '-' and '_'. +All metric names must start with a letter or number (A-Za-z0-9) and can contain '.', '-' and '_'. Send Metrics ~~~~~~~~~~~ @@ -114,6 +114,7 @@ Creating an alert ~~~~~~~~~~~ To create an alert:: + z.createAlert( alert_name="alert_name", username="username", @@ -130,12 +131,14 @@ Retrieving all alerts ~~~~~~~~~~~ To retrieve all alerts:: + z.getAlerts() Modifying an alert ~~~~~~~~~~~ To modify a specific alert:: + z.modifyAlert( alert_id=42 alert_name="alert_name", @@ -153,6 +156,7 @@ Retrieving description on a specific alert ~~~~~~~~~~~ To get information on an alert:: + z.getAlert( alert_id=25 ) @@ -161,6 +165,7 @@ Deleting an alert ~~~~~~~~~~~ To delete a alert:: + z.deleteAlert( alert_id=25 ) @@ -169,6 +174,7 @@ Bulk enabling alerts ~~~~~~~~~~~ To enable alerts:: + z.enableAlerts( alert_id_list=[25, 41, 7] ) @@ -177,6 +183,7 @@ Bulk disabling alerts ~~~~~~~~~~~ To disable alerts:: + z.disableAlerts( alert_id_list=[25, 41, 7] ) @@ -188,10 +195,12 @@ Retrieving all triggered alerts ~~~~~~~~~~~ To retrieve triggered alerts:: + z.getTriggeredAlerts() Retrieving all triggered alerts in the last 24 hours ~~~~~~~~~~~ To retrieve all alerts triggered in the past 24 hours:: + z.getTriggeredAlertsLast24Hours()