v1

latestOpenAPI 3.1.02026-07-262218115.4 KB

Retrieve audit logs for employee usage of the Knot Dashboard.

get/audit_logs

Query parameters

startstring date-time
Example:2025-01-01T00:00:00Z

Filter audit logs to those created on or after this timestamp. Must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

endstring date-time
Example:2025-12-31T23:59:59Z

Filter audit logs to those created on or before this timestamp. Must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

next_cursorstring
Example:eyJpZCI6MTIzNDU2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9

Cursor token for pagination. Use the next_cursor value from the previous response to retrieve the next page of results.

Response

Successful request.

next_cursorstring nullable

Cursor token for the next page of audit logs. Null if there are no further results.

limitinteger

Number of items per page.

Example response

{
  "data": [
    {
      "id": "a0b66190-9e04-4bc6-82ae-5d98e1f70e59",
      "datetime": "2025-12-23T15:48:58Z",
      "event": {
        "action": "merchant.hide",
        "outcome": {
          "status": "success"
        }
      },
      "actor": {
        "name": "Ada Lovelace",
        "email": "ada@lovelace.com"
      },
      "target": {
        "type": "merchant",
        "name": "Amazon Prime",
        "environment": "production"
      },
      "context": {
        "ip": "208.204.24.80",
        "user_agent": "Mozilla/5.0 ..."
      }
    }
  ],
  "limit": 100
}