Home
/
REST API Reference
/
Models
/
Data Event Summary Item

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 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"
}

Data Export CSV

A CSV output file

user_idstringrequired

The user_id of the user who was sent the message.

user_external_idstring

The external_user_id of the user who was sent the message

company_idstringrequired

The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.

emailstringrequired

The users email who was sent the message.

namestringrequired

The full name of the user receiving the message

ruleset_idstringrequired

The id of the message.

content_idstringrequired

The specific content that was received. In an A/B test each version has its own Content ID.

content_typestringrequired

Email, Chat, Post etc.

content_titlestringrequired

The title of the content you see in your Intercom workspace.

ruleset_version_idstring

As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.

receipt_idstring

ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.

received_atinteger

Timestamp for when the receipt was recorded.

series_idstring

The id of the series that this content is part of. Will return -1 if not part of a series.

series_titlestring

The title of the series that this content is part of.

node_idstring

The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.

first_replyinteger

The first time a user replied to this message if the content was able to receive replies.

first_completioninteger

The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.

first_series_completioninteger

The first time the series this message was a part of was completed by the user.

first_series_disengagementinteger

The first time the series this message was a part of was disengaged by the user.

first_series_exitinteger

The first time the series this message was a part of was exited by the user.

first_goal_successinteger

The first time the user met this messages associated goal if one exists.

first_openinteger

The first time the user opened this message.

first_clickinteger

The first time the series the user clicked on a link within this message.

first_dismisallinteger

The first time the series the user dismissed this message.

first_unsubscribeinteger

The first time the user unsubscribed from this message.

first_hard_bounceinteger

The first time this message hard bounced for this user

{
  "user_id": "string",
  "user_external_id": "string",
  "company_id": "string",
  "email": "string",
  "name": "string",
  "ruleset_id": "string",
  "content_id": "string",
  "content_type": "string",
  "content_title": "string",
  "ruleset_version_id": "string",
  "receipt_id": "string",
  "received_at": 0,
  "series_id": "string",
  "series_title": "string",
  "node_id": "string",
  "first_reply": 0,
  "first_completion": 0,
  "first_series_completion": 0,
  "first_series_disengagement": 0,
  "first_series_exit": 0,
  "first_goal_success": 0,
  "first_open": 0,
  "first_click": 0,
  "first_dismisall": 0,
  "first_unsubscribe": 0,
  "first_hard_bounce": 0
}