Search activity logs

Request

Search and filter admin activity logs using a POST request with event type filter in the request body. You can find more details about the available event types in the List all activity log event types endpoint.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.16"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.16

Bodyapplication/jsonrequired

created_at_afterinteger, (date-time)required

The start date that you request data for. It must be formatted as a UNIX timestamp.

Example:1677253093

created_at_beforeinteger, (date-time)

The end date that you request data for. It must be formatted as a UNIX timestamp.

Example:1677861493

event_typesArray of strings

An optional list of event types to filter activity logs by. Use the list all activity log event types endpoint to retrieve available values.

Example:

[
  "app_name_change",
  "message_state_change"
]

pageinteger

The page number of results to return.

Default:1

Example:1

per_pageinteger, [ 1 .. 250 ]

The number of results per page. Must be between 1 and 250.

Default:20

Example:20

curl -i -X POST \
  https://api.intercom.io/admins/activity_logs/search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.16' \
  -d '{
    "created_at_after": 1677253093,
    "created_at_before": 1677861493,
    "event_types": [
      "app_name_change",
      "message_state_change"
    ]
  }'

Responses

Successful response

Bodyapplication/json

typestring

String representing the object's type. Always has the value activity_log.list.

Example:"activity_log.list"

pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

activity_logsArray of objects(Activity Log)

An array of activity logs

Response

{
  "type": "activity_log.list",
  "pages": {
    "type": "pages",
    "next": null,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  },
  "activity_logs": [
    { … }
  ]
}