/livefeed/events

Retrieves events for a specific message in the live feed

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.
Query Params
string

The id of the message to fetch events for. Either this or contactEmail must be provided.

string

The email address of the contact to fetch events for. Either this or messageId must be provided.

boolean
required
Defaults to true

Whether the message was sent via Mixmax or some other client

boolean
Defaults to false

If contactEmail is provided, whether to also include events between the contactEmail and all of your Mixmax teammates. Only returns events related to messages that have been shared with the team (i.e. "Sync to Mixmax" is checked, and the domain of the recipient is not excluded in Team Live Feed settings.)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!