Audit Logging

Suggest Edits

We offer a GraphQL query named getAccountAuditLogs for the purpose of retrieving account activity information for audit logging. The response includes information like the IP-Address, login/logout times and in-app activity data points. An in-app activity, for example, refers to when a user changed a system setting or added an integration.

This query is designed to fetch account audit logs based on specified criteria, offering detailed insights into events related to API calls and user activities within a defined time range.

Usage

This API supports pagination, allowing a customer to collect audit logs by making paginated calls to the API.

Sample query

query getAccountAuditLogs(
  $startTime: DateTime!
  $apiCallReferences: [ApiCallReference]
  $includeApiQueries: Boolean
  $userEmail: String
  $first: Int
) {
  getAccountAuditLogs(
    startTime: $startTime
    apiCallReferences: $apiCallReferences
    includeApiQueries: $includeApiQueries
    userEmail: $userEmail
    first: $first
  ) {
    records {
      timestamp
      accountUuid
      accountName
      email
      firstName
      lastName
      url
      eventType
      apiName
      apiIsQuery
      apiCallReferences
      apiCallSource
      clientIp
    }
  }
}

Variables

{
  "startTime": "2023-12-01T12:00:00.000Z",
  "includeApiQueries": true,
  "userEmail": "[email protected]",
  "apiCallReferences": [
    {
      "parameterName": "resource_id",
      "parameterValues": ["04bb580a-7dee-4ff6-87ee-2aafe3545748", "cf351ffe-2332-4cef-9021-f0d753960a9d"]
    },
    {
      "parameterName": "dw_id",
      "parameterValue": "836a6113-c067-467c-ad08-68462f045fe6"
    }
  ],
  "first": 50
}

Documentation

Detailed documentation for this query is available in our API documentation here.

Notes

The data returned by this API may have a lag of up to 10 hours.

Updated 11 months ago