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.

Results are paginated by page number. Use page and per_page in the request body to choose a page. The next link in the response is a URL that keeps the query string of the request URL and sets page and per_page for the next page. It does not include the filters from your request body. To fetch the next page, send a POST request with the same request body to that URL. Query parameters in the next URL take precedence over page and per_page in the body.

Requires the read_admins OAuth scope.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

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

Example:Preview

Bodyapplication/jsonrequired

created_at_afterinteger, (date-time)

The start date that you request data for. It must be formatted as a Unix timestamp. If you leave it out, it defaults to 30 days before the request.

Example:1677253093

created_at_beforeinteger, (date-time)

The end date that you request data for. It must be formatted as a Unix timestamp. If you leave it out, it defaults to the time of the request.

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: Preview' \
  -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(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

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": [
    { … }
  ]
}