Message interactions

You can list message interactions on a specific message using the following endpoint. In order to get an Email message, you must have an active Email channel and perform a HTTP request with a valid access key

List message interactions

List message interactions

GET/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

messageId*string (uuid)

The ID for a message

channelId*string (uuid)

The ID for a channel

Response

200404

OK

Body

application/json

resultsarray of ChannelMessageInteraction

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/messages/{messageId}/interactions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "messageId": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "platformId": "text",
      "type": "clicked",
      "messageReference": "text",
      "messagePartsCount": 0,
      "messageTags": [
        "text"
      ],
      "receiver": {
        "connector": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifierValue": "text",
          "annotations": {
            "name": "text"
          },
          "types": [
            "text"
          ]
        }
      },
      "createdAt": "2024-11-21T09:06:07.763Z",
      "details": "text",
      "metadata": {
        "link": {
          "name": "text",
          "url": "text"
        },
        "button": {
          "payload": "text"
        },
        "reaction": {
          "emoji": "text",
          "action": "text"
        }
      }
    }
  ]
}

Email supports the following message interactions:

Interaction	Description
opened	A user has opened a message
clicked	A user has clicked a link
reported-as-spam	A user has reported a message as spam
unsubscribe-request	A user has requested to unsubscribe from messages

Additional information about the interactions can be found in the details field and metadata.link object as follows:

Interaction	Details	metadata.link	Description
opened	initial_open		Recipient opened a message in an email client, thus rendering a tracking pixel at the top of the message
	open		Recipient opened a message in an email client, thus rendering a tracking pixel at the bottom of the message
	amp_initial_open		Recipient opened an AMP message in an email client, thus rendering a tracking pixel at the top of the message
	amp_open		Recipient opened an AMP message in an email client, thus rendering a tracking pixel at the bottom of the message
clicked	click	name - link title url - link url clicked	Recipient clicked a tracked link in a message
	amp_click	name - link title url - link url clicked	Recipient clicked a tracked link in an AMP message
reported-as-spam	spam_complaint		Messages was classified as spam by the recipient
unsubscribe_request	link_unsubscribe		Recipient clicked the 'unsubscribe' button in an email client
	list_unsubscribe		Recipient clicked an 'unsubscribe' link in an email message