Type Alias GetAuditLogsData

Type declaration

• Optionalafter?: string

  Paginates by the ID of the audit-log which marks the end of the pagination range. Requires "before".

• Optionalbefore?: string

  Paginates by the ID of the audit-log which marks the beginning of the pagination range. Requires "after".

• Optionalcount?: string

  Limits the number audit-log documents to be returned. Default 100, maximum 1000.

• Optionalfilter[end]?: string

  Filter by the date range end.

• Optionalfilter[include]?: string

  Adds additional OR query logic to include results for additional objectTypes. For available objectTypes to use in this query param, see the enum in the filter[objectType] field.

• Optionalfilter[objectId]?: string

  Filters by the id of database object the event relates to. Requires filter[objectType].

• Optionalfilter[objectType]?:
      | "bill_subscription"
      | "business_rule"
      | "company"
      | "conversation"
      | "customer"
      | "message"
      | "search"
      | "shortcut"
      | "user"
      | "work_item"
      | "ip_rule"
      | "work_session"
      | "shopify_rest"

  Filters by the type of database object the event relates to.

• Optionalfilter[start]?: string

  Filter by the date range start.

• Optionalfilter[userId]?: string

  Filters by the ID of the user the event relates to.