{"_id":"59a612a535a1ca000f10958f","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"user":"5588b847f6c18d0d005bba01","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-30T01:19:33.188Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n   \"results\":[\n      {\n\t\t\t\t \"_id\":\"u6nw5I9kk4FHEFQ3L\",\n         \"userId\":\"PsASf8S3AzBJYTLg5\",\n         \"recipients\":[\n            {\n               \"name\":\"Elijah Baley\",\n               \"email\":\"elijah.baley:::at:::usr.com\"\n            }\n         ],\n         \"fromEmail\":\"susan.calvin@usr.com\",\n         \"fromName\":\"Susan Calvin\",\n         \"subject\":\"Message Subject\",\n         \"sent\":1503988200000,\n         \"service\":\"gmail\",\n         \"serviceMessageId\":\"15e2cae9772f8b1a\",\n         \"serviceThreadId\":\"15e2cae9772f8b1a\",\n         \"includeInTeamLiveFeed\":1,\n         \"showContentTeamFeed\":1,\n         \"trackingMuted\":0,\n         \"numOpens\":1,\n         \"numClicks\":1,\n         \"numDownloads\":0,\n         \"wasReplied\":1,\n         \"wasAccepted\":0,\n         \"wasDeclined\":0,\n         \"wasTentative\":0,\n         \"wasBounced\":0,\n         \"lastEventType\":\"replied\",\n         \"lastEventAt\":1503988216000,\n         \"lastEventByEmail\":\"pricj004@gmail.com\",\n         \"lastEventByName\":\"Susan Calvin\",\n         \"permalink\":\"https://mail-local.mixmax.com/m/gdPsASf8S3AzBJYTLg5bAP15e2cae9772f8bmaOxgxM8Q-PAf52tyFIoZILsdKbBQXM9pIAr2BKfHwLxc?view=plain\"\n      }\n   ],\n   \"hasNext\":true,\n   \"hasPrevious\":false,\n   \"next\":\"NTA\",\n   \"stats\":{\n      \"replied\":193,\n      \"deliveredWithTrackedOpens\":1695,\n      \"accepted\":34,\n      \"opened\":1510,\n      \"delivered\":1699,\n      \"deliveredWithTrackedInvites\":84,\n      \"tentative\":5,\n      \"bounced\":65,\n      \"sent\":1764,\n      \"clicked\":53,\n      \"downloaded\":13,\n      \"deliveredWithTrackedLinks\":250,\n      \"declined\":9,\n      \"deliveredWithTrackedFiles\":66,\n      \"recipients\": 720,\n      \"percentages\":{\n         \"opened\":89.08554572271386,\n         \"clicked\":21.2,\n         \"downloaded\":19.696969696969695,\n         \"replied\":11.359623307828134,\n         \"accepted\":40.476190476190474,\n         \"declined\":10.714285714285714,\n         \"tentative\":5.952380952380952,\n         \"bounced\":3.6848072562358274\n      }\n   }\n}","language":"json","status":200}]},"method":"get","examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/livefeed","language":"curl"}]},"settings":"","auth":"required","params":[{"_id":"59a612a535a1ca000f109595","ref":"","in":"query","required":false,"desc":"The query to execute. Takes the same format as queries in the live feed UI.","default":"","type":"string","name":"query"},{"_id":"59a612a535a1ca000f109594","ref":"","in":"query","required":false,"desc":"the RFC timezone descriptor (e.g. 'America/Los_Angeles') of  * the client. Used for determining date boundaries when parsing the search query.","default":"UTC","type":"string","name":"timezone"},{"_id":"59a612a535a1ca000f109593","ref":"","in":"query","required":false,"desc":"Restrict results to only these messages","default":"","type":"array_string","name":"messageIds"},{"_id":"59a612a535a1ca000f109592","ref":"","in":"query","required":false,"desc":"The number of results to return. Max 10,000.","default":"50","type":"int","name":"limit"},{"_id":"59a612a535a1ca000f109591","ref":"","in":"query","required":false,"desc":"Paging offset.","default":"0","type":"int","name":"offset"},{"_id":"59a612a535a1ca000f109590","ref":"","in":"query","required":false,"desc":"Whether to return aggregate stats with the query.","default":"true","type":"boolean","name":"stats"}],"url":"/v1/livefeed"},"isReference":true,"order":49,"body":"[block:api-header]\n{\n  \"title\": \"Search Query\"\n}\n[/block]\nWe use [this string format for our searches](https://github.com/nepsilon/search-query-parser). Supported parameters are:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"is\",\n    \"0-1\": \"*String*\",\n    \"0-2\": \"Filters messages based on activity status (e.g. 'opened', 'clicked', 'downloaded', 'replied', 'bounced'), as well as special operators 'internal' (whether the message is from and to the domain of the owning user) and  'private' (whether the message has been shared in the team live feed).\",\n    \"1-0\": \"to\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"Filters messages based on recipients. Accepts email addresses and domains.\",\n    \"2-0\": \"from\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"Filter messages based on the sending address. Accepts email addresses, team names, and special values 'me', 'myself' and 'everyone'.\",\n    \"3-0\": \"subject\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"Filter messages based on subject.\",\n    \"4-0\": \"sequence\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"Filter messages based on the sequence they belong to (by name). Also accepts '*', which means any sequence.\",\n    \"5-2\": \"Filter messages based on the template used (by name). Also accepts '*', which means any template.\",\n    \"5-1\": \"*String*\",\n    \"5-0\": \"template\",\n    \"6-0\": \"sent\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"Filter messages based on when they were sent. Accepts a date range string in the form `MM/DD/YYYY-MM/DD/YYYY`, or a special keyword such as 'yesterday'.\",\n    \"7-0\": \"salesforceAccount\",\n    \"7-1\": \"*String*\",\n    \"7-2\": \"Filter messages to those sent to members of this Salesforce account (by name).\",\n    \"8-0\": \"salesforceOpportunity\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"Filter messages to those sent to members of this Salesforce opportunity (by name).\",\n    \"9-0\": \"rsvp\",\n    \"9-1\": \"*String*\",\n    \"9-2\": \"Filter messages to those where the recipient replied to a meeting invitation with this response. Accepts 'yes', 'no', 'maybe' and 'noresponse'.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Response Format\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"results\",\n    \"0-1\": \"*Array*\",\n    \"0-2\": \"Array of messages matching the query\",\n    \"2-0\": \"results.userId\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"The ID of the user who owns the message\",\n    \"3-0\": \"results.recipients\",\n    \"3-1\": \"*Array*\",\n    \"3-2\": \"Array of message message recipients. Contains all recipients (`to`, `cc` and `bcc`).\",\n    \"4-0\": \"results.recipients.email\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"The email of the recipient.\",\n    \"5-0\": \"results.recipients.name\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"The name of the recipient.\",\n    \"6-0\": \"results.fromEmail\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"The email address the message was sent from.\",\n    \"7-0\": \"results.fromName\",\n    \"7-1\": \"*String*\",\n    \"7-2\": \"The name the message was sent from.\",\n    \"8-0\": \"results.subject\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"The subject of the message.\",\n    \"10-0\": \"results.service\",\n    \"10-1\": \"*String*\",\n    \"10-2\": \"The service the message was sent via e.g. 'gmail'.\",\n    \"11-0\": \"results.serviceMessageId\",\n    \"11-1\": \"*String*\",\n    \"11-2\": \"The ID of the message on the service.\",\n    \"12-0\": \"results.serviceThreadId\",\n    \"12-1\": \"*String*\",\n    \"12-2\": \"The ID of the thread on the service.\",\n    \"13-0\": \"results.includeInTeamLiveFeed\",\n    \"13-1\": \"*Integer*\",\n    \"13-2\": \"Whether the message is shown in the team live feed.\",\n    \"1-0\": \"results._id\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"Unique message ID\",\n    \"14-0\": \"results.showContentTeamLiveFeed\",\n    \"14-1\": \"*Integer*\",\n    \"14-2\": \"Whether the message content is visible in the team live feed.\",\n    \"15-0\": \"results.trackingMuted\",\n    \"15-1\": \"*Integer*\",\n    \"15-2\": \"Whether tracking is muted on this message.\",\n    \"16-0\": \"results.numOpens\",\n    \"16-1\": \"*Integer*\",\n    \"16-2\": \"Total number of opens on the message (across all recipients).\",\n    \"17-2\": \"Total number of clicks on the message (across all recipients).\",\n    \"17-1\": \"*Integer*\",\n    \"17-0\": \"results.numClicks\",\n    \"18-2\": \"Total number of downloads on the message (across all recipients).\",\n    \"18-1\": \"*Integer*\",\n    \"18-0\": \"results.numDownloads\",\n    \"19-0\": \"results.wasReplied\",\n    \"20-0\": \"results.wasAccepted\",\n    \"21-0\": \"results.wasDeclined\",\n    \"22-0\": \"results.wasTentative\",\n    \"23-0\": \"results.wasBounced\",\n    \"24-0\": \"results.lastEventType\",\n    \"25-0\": \"results.lastEventAt\",\n    \"26-0\": \"results.lastEventByEmail\",\n    \"27-0\": \"results.lastEventByName\",\n    \"28-0\": \"results.permalink\",\n    \"28-1\": \"*String*\",\n    \"27-1\": \"*String*\",\n    \"26-1\": \"*String*\",\n    \"24-1\": \"*String*\",\n    \"9-0\": \"results.sent\",\n    \"9-1\": \"*Integer*\",\n    \"9-2\": \"Timestamp the message was sent (ms).\",\n    \"19-1\": \"*Integer*\",\n    \"20-1\": \"*Integer*\",\n    \"21-1\": \"*Integer*\",\n    \"22-1\": \"*Integer*\",\n    \"23-1\": \"*Integer*\",\n    \"25-1\": \"*Integer*\",\n    \"25-2\": \"Timestamp the last event occurred (ms).\",\n    \"26-2\": \"The email address of the recipient who triggered the most recent event.\",\n    \"27-2\": \"The name of the recipient who triggered the most recent event.\",\n    \"28-2\": \"A permalink to this message.\",\n    \"19-2\": \"Whether the message has had a reply.\",\n    \"20-2\": \"Whether a meeting invite in this message has been accepted.\",\n    \"21-2\": \"Whether a meeting invite in this message has been declined.\",\n    \"22-2\": \"Whether a meeting invite in this message has been tentatively accepted.\",\n    \"23-2\": \"Whether the message has bounced.\",\n    \"24-2\": \"The type of the most recent event (e.g. 'opened').\",\n    \"29-0\": \"hasNext\",\n    \"29-1\": \"*Boolean*\",\n    \"29-2\": \"Whether there is a next page of results.\",\n    \"30-0\": \"hasPrevious\",\n    \"30-1\": \"*Boolean*\",\n    \"30-2\": \"Whether there is a previous page of results.\",\n    \"31-0\": \"next\",\n    \"31-1\": \"*String*\",\n    \"31-2\": \"The paging token to use to retrieve the next page of results.\",\n    \"32-0\": \"previous\",\n    \"32-1\": \"*String*\",\n    \"32-2\": \"The paging token to use to retrieve the previous page of results.\",\n    \"33-0\": \"stats\",\n    \"33-1\": \"*Object*\",\n    \"33-2\": \"Aggregate stats for the live feed query.\"\n  },\n  \"cols\": 3,\n  \"rows\": 34\n}\n[/block]","excerpt":"Retrieves live feed messages","slug":"livefeed","type":"endpoint","title":"/livefeed"}

get/livefeed

Retrieves live feed messages

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

query:
string
The query to execute. Takes the same format as queries in the live feed UI.
timezone:
stringUTC
the RFC timezone descriptor (e.g. 'America/Los_Angeles') of * the client. Used for determining date boundaries when parsing the search query.
messageIds:
array of strings
Restrict results to only these messages
limit:
integer50
The number of results to return. Max 10,000.
offset:
integer0
Paging offset.
stats:
booleantrue
Whether to return aggregate stats with the query.

Examples


Result Format


Documentation

[block:api-header] { "title": "Search Query" } [/block] We use [this string format for our searches](https://github.com/nepsilon/search-query-parser). Supported parameters are: [block:parameters] { "data": { "0-0": "is", "0-1": "*String*", "0-2": "Filters messages based on activity status (e.g. 'opened', 'clicked', 'downloaded', 'replied', 'bounced'), as well as special operators 'internal' (whether the message is from and to the domain of the owning user) and 'private' (whether the message has been shared in the team live feed).", "1-0": "to", "1-1": "*String*", "1-2": "Filters messages based on recipients. Accepts email addresses and domains.", "2-0": "from", "2-1": "*String*", "2-2": "Filter messages based on the sending address. Accepts email addresses, team names, and special values 'me', 'myself' and 'everyone'.", "3-0": "subject", "3-1": "*String*", "3-2": "Filter messages based on subject.", "4-0": "sequence", "4-1": "*String*", "4-2": "Filter messages based on the sequence they belong to (by name). Also accepts '*', which means any sequence.", "5-2": "Filter messages based on the template used (by name). Also accepts '*', which means any template.", "5-1": "*String*", "5-0": "template", "6-0": "sent", "6-1": "*String*", "6-2": "Filter messages based on when they were sent. Accepts a date range string in the form `MM/DD/YYYY-MM/DD/YYYY`, or a special keyword such as 'yesterday'.", "7-0": "salesforceAccount", "7-1": "*String*", "7-2": "Filter messages to those sent to members of this Salesforce account (by name).", "8-0": "salesforceOpportunity", "8-1": "*String*", "8-2": "Filter messages to those sent to members of this Salesforce opportunity (by name).", "9-0": "rsvp", "9-1": "*String*", "9-2": "Filter messages to those where the recipient replied to a meeting invitation with this response. Accepts 'yes', 'no', 'maybe' and 'noresponse'." }, "cols": 3, "rows": 10 } [/block] [block:api-header] { "title": "Response Format" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "results", "0-1": "*Array*", "0-2": "Array of messages matching the query", "2-0": "results.userId", "2-1": "*String*", "2-2": "The ID of the user who owns the message", "3-0": "results.recipients", "3-1": "*Array*", "3-2": "Array of message message recipients. Contains all recipients (`to`, `cc` and `bcc`).", "4-0": "results.recipients.email", "4-1": "*String*", "4-2": "The email of the recipient.", "5-0": "results.recipients.name", "5-1": "*String*", "5-2": "The name of the recipient.", "6-0": "results.fromEmail", "6-1": "*String*", "6-2": "The email address the message was sent from.", "7-0": "results.fromName", "7-1": "*String*", "7-2": "The name the message was sent from.", "8-0": "results.subject", "8-1": "*String*", "8-2": "The subject of the message.", "10-0": "results.service", "10-1": "*String*", "10-2": "The service the message was sent via e.g. 'gmail'.", "11-0": "results.serviceMessageId", "11-1": "*String*", "11-2": "The ID of the message on the service.", "12-0": "results.serviceThreadId", "12-1": "*String*", "12-2": "The ID of the thread on the service.", "13-0": "results.includeInTeamLiveFeed", "13-1": "*Integer*", "13-2": "Whether the message is shown in the team live feed.", "1-0": "results._id", "1-1": "*String*", "1-2": "Unique message ID", "14-0": "results.showContentTeamLiveFeed", "14-1": "*Integer*", "14-2": "Whether the message content is visible in the team live feed.", "15-0": "results.trackingMuted", "15-1": "*Integer*", "15-2": "Whether tracking is muted on this message.", "16-0": "results.numOpens", "16-1": "*Integer*", "16-2": "Total number of opens on the message (across all recipients).", "17-2": "Total number of clicks on the message (across all recipients).", "17-1": "*Integer*", "17-0": "results.numClicks", "18-2": "Total number of downloads on the message (across all recipients).", "18-1": "*Integer*", "18-0": "results.numDownloads", "19-0": "results.wasReplied", "20-0": "results.wasAccepted", "21-0": "results.wasDeclined", "22-0": "results.wasTentative", "23-0": "results.wasBounced", "24-0": "results.lastEventType", "25-0": "results.lastEventAt", "26-0": "results.lastEventByEmail", "27-0": "results.lastEventByName", "28-0": "results.permalink", "28-1": "*String*", "27-1": "*String*", "26-1": "*String*", "24-1": "*String*", "9-0": "results.sent", "9-1": "*Integer*", "9-2": "Timestamp the message was sent (ms).", "19-1": "*Integer*", "20-1": "*Integer*", "21-1": "*Integer*", "22-1": "*Integer*", "23-1": "*Integer*", "25-1": "*Integer*", "25-2": "Timestamp the last event occurred (ms).", "26-2": "The email address of the recipient who triggered the most recent event.", "27-2": "The name of the recipient who triggered the most recent event.", "28-2": "A permalink to this message.", "19-2": "Whether the message has had a reply.", "20-2": "Whether a meeting invite in this message has been accepted.", "21-2": "Whether a meeting invite in this message has been declined.", "22-2": "Whether a meeting invite in this message has been tentatively accepted.", "23-2": "Whether the message has bounced.", "24-2": "The type of the most recent event (e.g. 'opened').", "29-0": "hasNext", "29-1": "*Boolean*", "29-2": "Whether there is a next page of results.", "30-0": "hasPrevious", "30-1": "*Boolean*", "30-2": "Whether there is a previous page of results.", "31-0": "next", "31-1": "*String*", "31-2": "The paging token to use to retrieve the next page of results.", "32-0": "previous", "32-1": "*String*", "32-2": "The paging token to use to retrieve the previous page of results.", "33-0": "stats", "33-1": "*Object*", "33-2": "Aggregate stats for the live feed query." }, "cols": 3, "rows": 34 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}