Nylas has updated its pricing model.See current pricing on nylas.com →

Command

nylas deliverability tracking-events list

List opens and link clicks (newest first).

Written by Qasim Muhammad Staff SRE

What does nylas deliverability tracking-events list do?

The nylas deliverability tracking-events list command shows opens and link clicks, newest first, with the tracking label, clicked URL, and whether it was the first interaction. It covers only messages sent from an Agent Account or through Transactional send; messages from connected grants such as Google or Microsoft accounts are not included. Only messages sent with open or link tracking turned on have tracking events.

Usage

nylas deliverability tracking-events list [--event-type opened|link_clicked]... [--label LABEL] [--start TIME] [--end TIME] [--page-token TOKEN] [--json]

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limit(-n)Maximum number of items to show
--yes(-y)Skip confirmations
--endWindow end, inclusive, within the last 90 days; a date means the end of that UTC day (same formats; default: now)
--event-typeEvent type, repeatable: opened, link_clicked
--fromFrom address
--grant-idOnly events for this grant (agent account)
--labelTracking label set when the message was sent
--message-idMessage ID
--orderSort order: desc (newest first, default) or asc
--page-tokenPage token for pagination
--sending-domainSending domain
--startWindow start: Unix seconds, YYYY-MM-DD, "YYYY-MM-DD HH:MM[:SS]" or YYYY-MM-DDTHH:MM[:SS] (UTC), RFC3339, or look-back like 24h/7d (default: UTC midnight 6 days before --end, or before today)
--thread-idThread ID

Examples

The nylas deliverability tracking-events list command shows opens and link clicks, newest first, with the tracking label, clicked URL, and whether it was the first interaction.

Link clicks in the last 7 days

nylas deliverability tracking-events list --event-type link_clicked --start 7d

Every interaction for one label as JSON

nylas deliverability tracking-events list --label welcome-campaign --json

Troubleshooting

No tracking events for a message

Tracking events exist only when the message was sent from an Agent Account or through Transactional send with open or link tracking turned on. Messages from connected Google or Microsoft grants are not included.

invalid --start value

Use Unix seconds, YYYY-MM-DD (a whole UTC day), YYYY-MM-DD HH:MM[:SS] or YYYY-MM-DDTHH:MM[:SS] in UTC, RFC3339, or a look-back such as 24h or 7d. Words such as today or 9am are not accepted because they change between runs.

page_token is not valid for this request

A page token only works with the exact same filters, --start and --end. After a look-back such as --start 7d, use the Next page line the CLI prints, which repeats the resolved times as Unix seconds.

Recommended guides

Run nylas deliverability tracking-events list --help for full help output.