{"_id":"59a6169b18589f000f9210dc","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"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","5a31c9409a6f2000125c079f"],"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: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","githubsync":"","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-30T01:36:27.047Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/livefeed/events","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n   \"results\":[\n      {\n         \"_id\":\"59a50a20678f1a269412732d\",\n         \"type\":\"replied\",\n         \"timestamp\":1503988216000,\n         \"recipientEmail\":\"susan.calvin:::at:::usr.com\",\n         \"recipientName\":\"Susan Calvin\",\n         \"country\":\"United States\",\n         \"region\":\"California\",\n         \"city\":\"San Francisco\",\n         \"os\":\"Mac OS X\",\n         \"program\":\"Gmail\",\n         \"isMobile\":0,\n         \"linkUrl\":null,\n         \"linkText\":null,\n         \"fileName\":null\n      }\n   ]\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"59a612a535a1ca000f109595","ref":"","in":"query","required":false,"desc":"The id of the message to fetch events for.  Either this or `contactEmail` must be provided.","default":"","type":"string","name":"messageId"},{"_id":"5a2f00cb750f520028f01153","ref":"","in":"query","required":false,"desc":"The email address of the contact to fetch events for. Either this or `messageId` must be provided.","default":"","type":"string","name":"contactEmail"},{"_id":"59c04ac22126e10028effc9e","ref":"","in":"query","required":true,"desc":"Whether the message was sent via Mixmax or some other client","default":"true","type":"boolean","name":"wasSentViaMixmax"},{"_id":"5a58ffa8086a05001c432737","ref":"","in":"query","required":false,"desc":"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.)","default":"false","type":"boolean","name":"includeTeammates"}],"url":"/v1/livefeed/events"},"isReference":true,"order":50,"body":"[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\": \"Events for this message, capped at 200.\",\n    \"2-0\": \"results.type\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"The type of event (e.g. 'opened', 'replied' etc.)\",\n    \"3-0\": \"results.timestamp\",\n    \"3-1\": \"*Integer*\",\n    \"3-2\": \"Timestamp the event occurred (ms).\",\n    \"4-0\": \"results.recipientEmail\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"The email of the recipient who triggered the event.\",\n    \"5-0\": \"results.recipientName\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"The name of the recipient who triggered the event.\",\n    \"7-0\": \"results.region\",\n    \"7-1\": \"*String*\",\n    \"7-2\": \"The region/state/province the event occurred in. Approximate. May be null.\",\n    \"8-0\": \"results.city\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"The city the event occurred in. Approximate. May be null.\",\n    \"9-0\": \"results.os\",\n    \"9-1\": \"*String*\",\n    \"9-2\": \"The operating system the event was triggered from. May be null.\",\n    \"10-0\": \"results.program\",\n    \"10-1\": \"*String*\",\n    \"10-2\": \"The program/client the event was triggered from. May be null.\",\n    \"1-0\": \"results._id\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"Unique event ID\",\n    \"11-0\": \"results.isMobile\",\n    \"11-1\": \"*Integer*\",\n    \"11-2\": \"Whether the event was triggered from a mobile device. Approximate. May be null.\",\n    \"12-0\": \"results.linkUrl\",\n    \"12-1\": \"*String*\",\n    \"12-2\": \"The URL of the link that was clicked. Only present for 'clicked' events.\",\n    \"13-0\": \"results.linkText\",\n    \"13-1\": \"*String*\",\n    \"13-2\": \"The text of the link that was clicked. Only present for 'clicked' events.\",\n    \"14-2\": \"The name of the file that was downloaded. Only present for 'downloaded' events.\",\n    \"14-1\": \"*String*\",\n    \"14-0\": \"results.fileName\",\n    \"6-0\": \"results.country\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"The country the event occurred in. Approximate. May be null.\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]","excerpt":"Retrieves events for a specific message in the live feed","slug":"livefeedevents","type":"endpoint","title":"/livefeed/events"}

get/livefeed/events

Retrieves events for a specific message in the live feed

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

messageId:
string
The id of the message to fetch events for. Either this or `contactEmail` must be provided.
contactEmail:
string
The email address of the contact to fetch events for. Either this or `messageId` must be provided.
wasSentViaMixmax:
required
booleantrue
Whether the message was sent via Mixmax or some other client
includeTeammates:
booleanfalse
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.)

Examples


Result Format


Documentation

[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": "Events for this message, capped at 200.", "2-0": "results.type", "2-1": "*String*", "2-2": "The type of event (e.g. 'opened', 'replied' etc.)", "3-0": "results.timestamp", "3-1": "*Integer*", "3-2": "Timestamp the event occurred (ms).", "4-0": "results.recipientEmail", "4-1": "*String*", "4-2": "The email of the recipient who triggered the event.", "5-0": "results.recipientName", "5-1": "*String*", "5-2": "The name of the recipient who triggered the event.", "7-0": "results.region", "7-1": "*String*", "7-2": "The region/state/province the event occurred in. Approximate. May be null.", "8-0": "results.city", "8-1": "*String*", "8-2": "The city the event occurred in. Approximate. May be null.", "9-0": "results.os", "9-1": "*String*", "9-2": "The operating system the event was triggered from. May be null.", "10-0": "results.program", "10-1": "*String*", "10-2": "The program/client the event was triggered from. May be null.", "1-0": "results._id", "1-1": "*String*", "1-2": "Unique event ID", "11-0": "results.isMobile", "11-1": "*Integer*", "11-2": "Whether the event was triggered from a mobile device. Approximate. May be null.", "12-0": "results.linkUrl", "12-1": "*String*", "12-2": "The URL of the link that was clicked. Only present for 'clicked' events.", "13-0": "results.linkText", "13-1": "*String*", "13-2": "The text of the link that was clicked. Only present for 'clicked' events.", "14-2": "The name of the file that was downloaded. Only present for 'downloaded' events.", "14-1": "*String*", "14-0": "results.fileName", "6-0": "results.country", "6-1": "*String*", "6-2": "The country the event occurred in. Approximate. May be null." }, "cols": 3, "rows": 15 } [/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 }}