AMamperity
Audit Events

List audit events

Return a log of user activity that occurred in your tenant. Each response may contain up to 1000 audit events. When requesting events for a production tenant, all events (including events from sandboxes created for that tenant) are included in the response. When requesting events from a sandbox, only events from that sandbox are included in the response.

get/audit-events

Request

Query parameters

api_versionstring

A supported version of the Amperity API. You may use the api-version request header instead of the api_version request parameter.

with_totalboolean

Set this value to true to include a total count of all results. Default value: false. Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.

limitinteger

The maximum number of records to include in a single page of results.

next_tokenstring

An opaque token that is used to paginate results. Omit the next_token property to return the first page. Use the cursor value for next_token that was returned in a response to view the next page of results. The value cannot be empty.

happened_fromstring date-time

The start date (inclusive) that defines the beginning of the time range for which audit events will be returned. The date should be in ISO-8601 format and in UTC, such as 2026-04-01T11:11:11Z.

happened_tostring date-time

The end date (exclusive) that defines the end of the time range for which audit events will be returned. The date should be in ISO-8601 format and in UTC, such as 2026-04-02T11:11:11Z.

Headers

Amperity-Tenantstring required

The ID for the tenant to which a request will be sent.

Api-Versionstring required

A supported version of the Amperity API.

Response

List of audit events

next_tokenstring

The cursor value to use in a subsequent request to return the next page of results.

totalinteger

The total count of all results. This property is only returned when with_total is set to true in a request.

Example response

{
  "data": [
    {
      "event_id": "ae-21HCWon6Y",
      "event_type": ":amperity.plugin.credential/updated",
      "happened_at": "2024-04-09T17:21:06.747Z",
      "object_id": "seg-35GMWpn6Y",
      "object_name": "demo segment",
      "origin_ip": "127.0.0.1",
      "principal_email": "example@amperity.com",
      "principal_id": "google-apps|amperity@amperity.com",
      "principal_name": "bob smith",
      "session_id": "6cs8Zm1nZFmh2Yn3jfW2cNwpmHwHVn",
      "tenant": "acme-sb",
      "tenant_family": "acme",
      "user_agent": "Chrome 1.2.3 / Mac OS X 4.5.6"
    }
  ],
  "next_token": "ZVEy1iwsKBs9a6H"
}

Changes

No recorded changes to this operation across all 1 revision of this API.