/livefeed

get

https://api.mixmax.com/v1/livefeed

Searches the live feed: messages you sent, or that teammates shared, with their tracking results, sorted by most recent activity first.

By default only your own messages are returned (the query defaults to from:me). Messages from teammates appear only when they were shared to the team live feed.

Each page can include aggregate stats for every message matching the query. Paging stops at 10,000 results; narrow the query to see older messages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

A search in the same format as the live feed search box. Words without an operator match the subject or a recipient's name, and all words must match. A bare email address or domain is read as to:. Put - before an operator or word to exclude matches, put values with spaces in double quotes (subject:"quarterly review"), and separate several values for one operator with commas. Operators:

is: One of opened, clicked, downloaded, replied, bounced, internal (sent to your own domain), private (not shared to the team live feed) or mixmax (sent through Mixmax rather than another email client). Several is: values, repeated or comma-separated, must all match. replied and bounced need reply tracking on your plan; without it the response is 400.
has:attachment Messages with a tracked file.
to: A recipient email address or domain. Several values match any of them.
from: me or myself, everyone, a teammate's email address, or a group name. Defaults to me. If the query has only -from: clauses, it starts from everyone.
delegator: The email address or domain of the person a message was sent on behalf of.
subject: Words in the subject.
sequence: A sequence name (exact, case-insensitive), or * for any sequence. An unknown name returns 400.
sequenceFolder: A sequence folder name. An unknown name returns 400.
template: A template name, or * for messages that used any template.
sent: today, yesterday, thisweek, lastweek, thismonth, lastmonth, last12months, thisyear, lastyear, last<N>days (for example last30days), a date MM/DD/YYYY, or a range MM/DD/YYYY-MM/DD/YYYY. Dates use the timezone parameter.
salesforceAccount: Messages sent to contacts of the Salesforce account with this name.
salesforceOpportunity: Messages sent to contacts of the Salesforce opportunity with this name.
rsvp: A meeting invite response, one of yes, no, maybe or noresponse.

Operators not in this list are ignored. Unknown values for is:, has:, rsvp: and sent: return 400.

timezone

string

Defaults to UTC

An IANA time zone name, such as America/Los_Angeles, used to work out day boundaries for sent:.

limit

int32

0 to 300

Defaults to 50

Number of messages to return, from 0 to 300. A larger value returns 400.

offset

int32

≥ 0

Defaults to 0

Number of matching messages to skip. Ignored when next or previous is set.

string

The next token from a previous page.

string

The previous token from a previous page.

stats

boolean

Defaults to true

Set to false to leave out stats, which makes the request faster. Useful after the first page.

showOnlySyncedToMixmax

boolean

Defaults to false

Set to true to return only messages shared to the team live feed. This adds -is:private to the query.

messageIds

array of strings

Returns only these messages, if they also match the query. Repeat the parameter for several ids. Paging parameters are ignored and the response has no paging fields.

messageIds

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200A page of live feed messages.

400A parameter or the query could not be understood: limit out of range, a paging token that is not valid, an unknown operator value, or a sequence or folder name that does not exist.

403The request used an admin-managed API key. This endpoint accepts only personal API tokens. A key limited to specific scopes is refused with This API does not support scoped credentials, and a key with the * scope with This API does not support managed API credentials yet.