/livefeed/events

Lists tracking events (opens, clicks, downloads, replies, bounces and meeting invite responses) for one live feed message or for one contact, newest first. Pass messageId or contactEmail.

With messageId, the last page ends with an extra sent event for the message itself. In that event, recipientEmail and recipientName hold the sender's address and name.

A request with neither parameter, an unknown messageId, or a paging token that is not valid currently returns 500.

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

The _id of a live feed message. Either this or contactEmail is required.

boolean
Defaults to true

Whether the message in messageId was sent through Mixmax. Use the message's wasSentViaMixmax value from GET /v1/livefeed; pass false for messages sent from another email client, or the message is not found.

string

A recipient email address. Returns that contact's events across your messages. Either this or messageId is required.

boolean
Defaults to false

Set to true to include events on messages from people who share a group with you (every workspace member, if you have admin access), limited to messages shared to the team live feed. Your own messages are then included only if they were shared too.

boolean
Defaults to false

Same as includeGroupMembers. Used only when includeGroupMembers is not set.

int32
Defaults to 200

Number of events to return.

string

The next token from a previous page. Tokens from GET /v1/livefeed do not work here.

Responses

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