Search Activity Logs

Search activity logs

POST/admins/activity_logs/search

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Search Activity Logs action (under Admins).
Fill in the fields below, then reference the result from later steps as {{searchActivityLogs.response.data}}.

Request

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Request body

Enter the body as JSON in the step's Body field.

created_at_afterinteger (date-time)required

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

created_at_beforeinteger (date-time)

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

event_typesarray<string>

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

pageinteger

The page number of results to return.

Default 1

per_pageinteger

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

Default 20

json

{
  "created_at_after": 1677253093,
  "created_at_before": 1677861493,
  "event_types": [
    "app_name_change",
    "message_state_change"
  ],
  "page": 1,
  "per_page": 20
}

Response

Returns 200 with an object. Read it in later steps with {{searchActivityLogs.response.data.<field>}}.

typestring

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

pagesobject

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.

typestring

the type of object `pages`.

One ofpages

pageinteger

The current page

nextobject2 fields

per_pageinteger

Number of results per page

total_pagesinteger

Total number of pages

activity_logsarray<object>

An array of activity logs

idstring

The id representing the activity.

performed_byobject4 fields

Details about the Admin involved in the activity.

metadataobject19 fields

Additional data provided about Admin activity.

created_atinteger (date-time)

The time the activity was created.

activity_typestring

One ofadmin_conversation_assignment_limit_changeadmin_ticket_assignment_limit_changeadmin_avatar_changeadmin_away_mode_changeadmin_deletionadmin_deprovisionedadmin_impersonation_endadmin_impersonation_startadmin_impersonation_consent_approvedadmin_impersonation_consent_revokedadmin_invite_changeadmin_invite_creationadmin_invite_deletionadmin_login_failureadmin_login_successadmin_logoutadmin_password_reset_requestadmin_password_reset_successadmin_permission_changeadmin_provisionedadmin_two_factor_auth_changeadmin_unauthorized_sign_in_methodapp_admin_joinapp_authentication_method_changeapp_data_deletionapp_data_exportapp_google_sso_domain_changeapp_identity_verification_changeapp_name_changeapp_outbound_address_changeapp_package_installationapp_package_token_regenerationapp_package_uninstallationapp_team_creationapp_team_deletionapp_team_membership_modificationapp_timezone_changeapp_webhook_creationapp_webhook_deletionarticles_in_messenger_enabled_change

activity_descriptionstring

A sentence or two describing the activity.

json

{
  "type": "activity_log.list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": {
      "per_page": 2,
      "starting_after": "your-cursor-from-response"
    },
    "per_page": 2,
    "total_pages": 13
  },
  "activity_logs": [
    {
      "id": "6",
      "performed_by": {
        "type": "admin",
        "id": "1295",
        "email": "john@example.com",
        "ip": "198.51.100.255"
      },
      "metadata": {
        "sign_in_method": "email_password",
        "external_id": "f3b87a2e09d514c6c2e79b9a",
        "away_mode": true,
        "away_status_reason": "😌 On a break",
        "reassign_conversations": false,
        "source": "admin update from web - Admin id: 93",
        "auto_changed": false,
        "update_by": 93,
        "update_by_name": "Joe Example",
        "conversation_assignment_limit": 15,
        "ticket_assignment_limit": 20,
        "team": {
          "id": 123,
          "name": "Support Team"
        }
      },
      "created_at": 1671028894,
      "activity_type": "app_name_change",
      "activity_description": "Admin updated the app's name to \"My App\"."
    }
  ]
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?