Return a message's opens and clicks - Tracking Events - API Reference

GET

https://api.us.nylas.com/v3/activity/tracking/messages/{message_id}

Returns engagement for one message: how many times it was opened, when it was first and last opened, and how many clicks each link got. Opens and clicks are counted per message, not per recipient. Covers messages sent in the last 90 days.

NYLAS API KEY

Parameters

Path parameters

message_id*string

The ID of the message. For an Agent Account send, this is the message ID the send returned. For a transactional send, it's the message's Message-ID header, such as <[email protected]>. Percent-encode it in the path: %3C0100019a1b2c3d4e%40mail.example.com%3E.

Example: "5a8f7b2e-3c1d-4e9f-8a6b-2d4c6e8f0a1b"

Responses

request_idstring

The request ID.

dataobject

Opens and link clicks for one message.

message_idstring

The ID of the message.

Example: "7e15afb2-ba2b-4f3b-b72d-cbbf04921fc1"

thread_idstring

The Agent Account thread the message belongs to. Empty for a transactional send.

Example: "b6b9461a-1ebd-4fb6-9cae-df7dc1f31baa"

grant_idstring

The Agent Account grant that sent the message. Empty for a transactional send.

Example: "0b7e5a6b-0cbd-4a39-b3ba-2b53b1b0a7d6"

fromstring

The email address the message was sent from.

Example: "[email protected]"

sending_domainstring

The domain the message was sent from.

Example: "mail.example.com"

labelstring

The tracking_options.label you set when you sent the message.

Example: "october-newsletter"

trackingobject

Which kinds of tracking were turned on when the message was sent.

opensobject

Opens of the message. Opens are counted per message, not per recipient.

clicksobject

Link clicks in the message.

eventsarray<object>

The 100 most recent opens and clicks, newest first. The totals count every open and click.