Developer APIResourcesEnvironment management

Get activity audit log

Retrieves detailed information on activities within a specific environment. Each log entry includes the event`s unique identifier, timestamp, type, and details about the workspace, user, and resource involved:

  • The workspace object contains the workspace ID, name, email, and environment.
  • The user object includes the user ID, name, and email.
  • The details object provides additional information about the request, including the IP address, user agent, and the specific activity performed.
  • The resource object describes the resource involved, including its ID, name, type, and associated email if applicable.

To obtain logs from different environments, create separate API clients for each environment and combine the data as required for your use case. The following environments can appear in your response, depending on the API client associated with your environment:

  • dev (Development)
  • sandbox (Sandbox)
  • test (Test)
  • stage (Staging)
  • uat (User Acceptance Testing)
  • preprod (Pre-Production)
  • prod (Production)

All data centers use the . timezone, Pacific Daylight Time (PDT). set to you specify a timezone in the from and to query parameters, the . converts it to and displays it as PDT.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

exclude_event_typesstringOptional
Exclude activities of the specified event types.
page[after]integerOptional
Specify the starting point for the next set of results based on the last result of the current page.
fromstringOptional

Specify the start of the time range for which to retrieve audit logs. Provide in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).

tostringOptional

Specify the end of the time range for which to retrieve audit logs. Provide in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).

users_idsintegerOptional
Filter logs to include activities performed by specified user IDs.
include_resource_typesstringOptional
Filter logs to include activities related to specified resource types.
exclude_resource_typesstringOptional
Exclude activities related to specified resource types.
include_event_typesstringOptional
Filter logs to include activities of specified event types.
page[size]integerOptional

Specify the number of results per page. The default and maximum number of records is 100.

Response

Success response
datalist of objects or null
List of activity logs.
totalinteger or null
Total number of log entries returned.

Errors