Skip to content
Skip to main content
GET
https://api.us.nylas.com/v3/metrics/tracking/summary

Return an engagement summary

Returns your open and click rates for a date window, compared with the previous window of the same length, with the counts behind them. Use it to see whether engagement is going up or down.

The open rate is the share of messages with open tracking that were opened at least once. Treat it as a trend rather than an exact count: some mail clients and privacy features load images automatically, which counts as an open. Messages count on the day they were sent, so rates for recent days keep rising as recipients open them.

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"

Responses

request_idstring

The request ID.

dataobject
GEThttps://api.us.nylas.com/v3/metrics/tracking/summary?start=2026-10-01&end=2026-10-30&sending_domain=mail.example.com

Find your API key in the Nylas Dashboard under API Keys in your application settings.

startstring

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.

endstring

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.

sending_domainstring

Return only data for messages sent from this domain.