NYnylas
Tracking events

List tracking events

Changed on

Returns opens and link clicks on your tracked messages, newest first. Filter by message, sender, label, or event type to see who engaged with a campaign and which links they clicked.

Covers transactional and Agent Account sends that had open or link click tracking turned on. Events are kept for 90 days, and the default window is the last 7 days.

This endpoint is for looking back at events, not for real-time updates. Avoid polling it for new events. To act on each open or click as it happens, use webhook notifications.

get/v3/activity/tracking

Request

Query parameters

event_typestring[]

Return only these event types. Repeat the parameter to include both.

labelstring

Return only events for messages sent with this tracking_options.label.

sending_domainstring

Return only data for messages sent from this domain.

fromstring

Return only events for messages sent from this email address.

grant_idstring

Return only events for messages sent by this Agent Account grant.

message_idstring

Return only events for this message.

thread_idstring

Return only events for messages in this Agent Account thread.

startinteger

Return events at or after this time, as a Unix timestamp in seconds. Defaults to midnight UTC six days ago, so the default window covers the last 7 days. Activity is kept for 90 days, so an earlier value returns events from the last 90 days only.

endinteger

Return events at or before this time, as a Unix timestamp in seconds. Defaults to the time of the request. Must not be earlier than start.

order'desc' | 'asc'

The sort order of the results by event time. desc returns the newest events first.

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.

Response

Success. Returns a page of tracking events.

request_idstring

The request ID.

next_cursorstring nullable

A cursor pointing to the next page of results for the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "next_cursor": "CigKGjRlaDdyNGQydTFqbWJ0bGo5a2QxdWJtdDZnGAEggIDAu7fw7bEYGg8IABIAGPjh2PGEi_0CIAEiBwgCEOqs6i4="
}

Changes