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

Command

nylas deliverability tracking-events breakdown

Show engagement per sending domain or agent account.

Written by Qasim Muhammad Staff SRE

What does nylas deliverability tracking-events breakdown do?

The nylas deliverability tracking-events breakdown command ranks engagement by sending domain or agent account, with tracked messages, first opens and clicks, and open and click rates. 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 breakdown [--group-by sending_domain|agent_account] [--sort KEY:asc|desc] [--limit N] [--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)Rows to show before the rest are summed into (others), 1-100
--yes(-y)Skip confirmations
--endLast UTC day, YYYY-MM-DD, inclusive (default: today)
--group-byDimension: sending_domain, agent_account (default sending_domain)
--sending-domainOnly this sending domain
--sortSort as <key>:<asc|desc>; keys: key, tracked_opens, tracked_links, open_rate, click_rate (default tracked_opens:desc)
--startFirst UTC day, YYYY-MM-DD (default: 6 days before --end)

Examples

The nylas deliverability tracking-events breakdown command ranks engagement by sending domain or agent account, with tracked messages, first opens and clicks, and open and click rates.

Agent accounts by open rate

nylas deliverability tracking-events breakdown --group-by agent_account --sort open_rate:desc

Troubleshooting

invalid --start value on a metrics command

Metrics windows take UTC dates in YYYY-MM-DD form, both days included, and can span at most 365 days. Unix timestamps and look-backs are for the activity list commands only.

A rate shows a dash instead of 0%

A dash means the rate has no denominator in the window (for example no sends), so there is no data. It is not a 0% rate.

Recommended guides

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