Add an example using the Monitors API

examples/find-monitors.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env -S deno run --allow-env --allow-net
+
+import DatadogApi from "../mod.ts";
+const datadogApi = DatadogApi.fromEnvironment(Deno.env);
+
+// This example looks at all monitors using any APM trace metrics,
+// and prints links to those which are not scoped to an APM environment.
+
+let count = 0;
+// Search for relevant monitors via a metric filter
+for await (const monitor of datadogApi.v1Monitors.searchToEnd("metric:trace*")) {
+
+  // Skip monitors that have a scoped environment set
+  if (!monitor.query.includes('env:production')) continue;
+  if (!monitor.query.includes('env:sandbox')) continue;
+
+  // Print the monitor URL for further manual inspection
+  console.log(`https://app.datadoghq.eu/monitors/${monitor.id}`);
+  count++;
+}
+// Print number of matched monitors as a summary
+console.log({count})

v1/monitors.ts

@@ -8,6 +8,12 @@ interface ApiClient {
   }): Promise<unknown>;
 }
 
+/**
+ * Monitors allow you to watch a metric or check that you care about,
+ * notifying your team when some defined threshold is exceeded.
+ *
+ * Official API docs: https://docs.datadoghq.com/api/latest/monitors/
+ */
 export default class DatadogMonitorsApi {
   #api: ApiClient;
   constructor(api: ApiClient) {