Merge pull request #2301 from buildkite/audit-event-time

Added timeboxed Auditevents example to the GraphQL Cookbook
buildkite · Aug 11, 2023 · 1addf5f · 1addf5f
2 parents 7a3cf5a + 22b67bc
commit 1addf5f
Showing 1 changed file with 37 additions and 13 deletions.
diff --git a/pages/apis/graphql/graphql_cookbook.md b/pages/apis/graphql/graphql_cookbook.md
@@ -1004,25 +1004,49 @@ mutation deleteOrgMember {
 Query your organization's audit events. Audit events are only available to Enterprise customers.
 
 ```graphql
-  query getOrganizationAuditEvents{
-    organization(slug:"organization-slug"){
-      auditEvents(first: 500){
-        edges{
-          node{
+query getOrganizationAuditEvents{
+  organization(slug:"organization-slug"){
+    auditEvents(first: 500){
+      edges{
+        node{
+          type
+          occurredAt
+          actor{
+            name
+          }
+          subject{
+            name
+            type
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+To get all audit events in a given period, use the `occurredAtFrom` and `occurredAtTo` filters like in the following query:
+
+```graphql
+query getTimeScopedOrganizationAuditEvents{
+  organization(slug:"organization-slug"){
+    auditEvents(first: 500, occurredAtFrom: "2023-01-01T12:00:00.000", occurredAtTo: "2023-01-01T13:00:00.000"){
+      edges{
+        node{
+          type
+          occurredAt
+          actor{
+            name
+          }
+          subject{
+            name
             type
-            occurredAt
-            actor{
-              name
-            }
-            subject{
-              name
-              type
-            }
           }
         }
       }
     }
   }
+}
 ```
 
 ## Teams