Return engagement over time - Tracking Events - API Reference

GET

https://api.us.nylas.com/v3/metrics/tracking/timeseries

Returns open and click counts and rates bucketed by day, week, or month. Use it to compare engagement across date ranges and to see how a campaign performed against earlier sends. A window can cover up to 365 days.

NYLAS API KEY

Parameters

Query parameters

startstring<date>

The first day of the window, as a UTC date in YYYY-MM-DD format. Defaults to six days before end, so the default window covers 7 days. A window can cover up to 365 days.

Example: "2026-10-01"

endstring<date>

The last day of the window, as a UTC date in YYYY-MM-DD format. Defaults to today. Today is included as a partial day.

Example: "2026-10-30"

sending_domainstring

Return only data for messages sent from this domain.

Example: "mail.example.com"

granularitystring

The size of each time bucket. auto picks day for windows up to 21 days, week for windows up to 92 days, and month for longer windows. Weeks start on Monday.

autodayweekmonth

Default: "auto"

Responses

request_idstring

The request ID.

dataobject

curl --request GET \ --url "https://api.us.nylas.com/v3/metrics/tracking/timeseries?start=2026-09-01&end=2026-10-30&granularity=week" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>'