/livefeed/events

Retrieves events for a specific message in the live feed

Response Format

Parameter

Type

Description

results

Array

Events for this message, capped at 200.

results._id

String

Unique event ID

results.type

String

The type of event (e.g. 'opened', 'replied' etc.)

results.timestamp

Integer

Timestamp the event occurred (ms).

results.recipientEmail

String

The email of the recipient who triggered the event.

results.recipientName

String

The name of the recipient who triggered the event.

results.country

String

The country the event occurred in. Approximate. May be null.

results.region

String

The region/state/province the event occurred in. Approximate. May be null.

results.city

String

The city the event occurred in. Approximate. May be null.

results.os

String

The operating system the event was triggered from. May be null.

results.program

String

The program/client the event was triggered from. May be null.

results.isMobile

Integer

Whether the event was triggered from a mobile device. Approximate. May be null.

results.linkUrl

String

The URL of the link that was clicked. Only present for 'clicked' events.

results.linkText

String

The text of the link that was clicked. Only present for 'clicked' events.

results.fileName

String

The name of the file that was downloaded. Only present for 'downloaded' events.

Language
Authentication
Header
Click Try It! to start a request and see the response here!