Skip to content
Home
/
REST API Reference
/
Models
/
Data Event Summary

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Data Event List

This will return a list of data events for the App.

typestringrequired

The type of the object

Value"event.list"
Example: "event.list"
eventsArray of objects(Data Event)required

A list of data events

events[].​typestring

The type of the object

Value"event"
Example: "event"
events[].​event_namestringrequired

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

Example: "invited-friend"
events[].​created_atinteger(date-time)required

The time the event occurred as a UTC Unix timestamp

Example: 1671028894
events[].​user_idstring

Your identifier for the user.

Example: "314159"
events[].​idstring

Your identifier for a lead or a user.

Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"
events[].​intercom_user_idstring

The Intercom identifier for the user.

Example: "63a0979a5eeebeaf28dd56ba"
events[].​emailstring

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

Example: "frodo.baggins@example.com"
events[].​metadataobject

Optional metadata about the event.

Example: {"invite_code":"ADDAFRIEND"}
pagesobject

Pagination

{
  "type": "event.list",
  "events": [
    { … }
  ],
  "pages": {
    "next": "https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user\"",
    "since": "https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065"
  }
}

Data Event Summary

This will return a summary of data events for the App.

typestringrequired

The type of the object

Value"event.summary"
Example: "event.summary"
emailstringrequired

The email address of the user

Example: "Sam.Sung@example.com"
intercom_user_idstringrequired

The Intercom user ID of the user

Example: "63a0979a5eeebeaf28dd56ba"
user_idstringrequired

The user ID of the user

Example: "62b997f288e14803c5006932"
eventsArray of objects(Data Event Summary Item)required

A summary of data events

events[].​namestringrequired

The name of the event

Example: "placed-order"
events[].​firststringrequired

The first time the event was sent

Example: "2014-01-16T23:12:21.000+00:00"
events[].​laststringrequired

The last time the event was sent

Example: "2014-01-16T23:12:21.000+00:00 "
events[].​countintegerrequired

The number of times the event was sent

Example: 1
events[].​descriptionstringrequired

The description of the event

Example: "A user placed an order"
{
  "type": "event.summary",
  "email": "Sam.Sung@example.com",
  "intercom_user_id": "63a0979a5eeebeaf28dd56ba",
  "user_id": "62b997f288e14803c5006932",
  "events": [
    { … }
  ]
}

Data Event Summary Item

This will return a summary of a data event for the App.

namestringrequired

The name of the event

Example: "placed-order"
firststringrequired

The first time the event was sent

Example: "2014-01-16T23:12:21.000+00:00"
laststringrequired

The last time the event was sent

Example: "2014-01-16T23:12:21.000+00:00 "
countintegerrequired

The number of times the event was sent

Example: 1
descriptionstringrequired

The description of the event

Example: "A user placed an order"
{
  "name": "placed-order",
  "first": "2014-01-16T23:12:21.000+00:00",
  "last": "2014-01-16T23:12:21.000+00:00 ",
  "count": 1,
  "description": "A user placed an order"
}