AHaha
Audits

Retrieve record history with a user field change

Changed on

Audit records describe historical changes to records in Aha! and are created automatically when a record is created, updated, or deleted. Audits are immutable and cannot be modified or deleted.

Audits are stored not only for first-class objects such as Features or Release, but also for secondary objects attached to those records such as custom field values, equation field values, descriptions, and record links.

Audit records are only available for the last 12 calendar months. After that, they must be accessed using the Historical Audits endpoint.

The performance of the Audits API can be improved by judicious use of the created_since and created_before parameters. Since this is high-volume timeseries data, these parameters should be used when attempting to scan through record activity, and the after_id parameter should be used in lieu of pagination.

get/audits

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring
per_pagestring
auditable_idstring
auditable_typestring
fieldsstring
associated_idstring
associated_typestring

Response

Successful operation

Example response

{
  "audits": [],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1
  }
}

Changes

  • 69bd8c9e8932Revision changes
    • info

      added the new optional query request parameter auditable_id

    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

  • 0aeec39d0f46Revision changes
    • info

      endpoint added