Auditlog Endpoint

Version:
Current
Last modified: October 30, 2020

Do not delete this has styles that are applied to the article.

This help page covers the usage of a Gallery API endpoint. If you are new to APIs visit the Get Started with APIs help page. To get stated with the Gallery API, visit the Gallery API Overview

Server tracks changes to these system entities:

  • AppInfo (Workfloww)
  • Collection
  • Credential
  • Subscription
  • User

Get Logged Events via the Gallery API

Any updates to these entities triggers the creation of an AuditEvent record. You can return these records via a public Admin API endpoint. 

Endpoint

The endpoint for AuditEvents is GET /admin/v1/auditlog/

Required Query Parameters

  • entity: (string) the audit log entity you want to query.
  • page: (int) The page you want to return.
  • pageSize: (int) The number of records you want to return on each page.

The response will be an array of Audit Event records:

[
  {
    "id": "",
    "entity": "",
    "entityId": "",
    "userId": "",
    "timestamp": "Date",
    "event": "",
    "oldValues": "",
    "newValues": ""
  }
]

The returned properties are defined below:

  • id: The Audit Event ID.
  • entity: The name of the entity.
  • entityId: The entity ID of the entity.
  • userId: The ID of the user who modified the entity.
  • timestamp: Date and Time of when the Audit Event record was created.
  • event: The event which occurred (insert, update, delete).
  • oldValues: The values of the updated properties prior to the update occurring.
  • newValues: The values of the updated properties after the update has occurred.
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.