/livefeed/events

Retrieves events for a specific message in the live feed

Response Format

ParameterTypeDescription
resultsArrayEvents for this message, capped at 200.
results._idStringUnique event ID
results.typeStringThe type of event (e.g. 'opened', 'replied' etc.)
results.timestampIntegerTimestamp the event occurred (ms).
results.recipientEmailStringThe email of the recipient who triggered the event.
results.recipientNameStringThe name of the recipient who triggered the event.
results.countryStringThe country the event occurred in. Approximate. May be null.
results.regionStringThe region/state/province the event occurred in. Approximate. May be null.
results.cityStringThe city the event occurred in. Approximate. May be null.
results.osStringThe operating system the event was triggered from. May be null.
results.programStringThe program/client the event was triggered from. May be null.
results.isMobileIntegerWhether the event was triggered from a mobile device. Approximate. May be null.
results.linkUrlStringThe URL of the link that was clicked. Only present for 'clicked' events.
results.linkTextStringThe text of the link that was clicked. Only present for 'clicked' events.
results.fileNameStringThe name of the file that was downloaded. Only present for 'downloaded' events.
Language
Credentials
Header
Psst... like working with APIs? Come join us!