Skip to the documentation
CLI

nextmail analytics

Every command in this namespace, with its arguments, flags and examples.

Commands

The numbers behind the Analytics page: how mail arrives in the mailbox, and what became of the mail the workspace sent.

Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags

nextmail analytics mailbox

Read how mail arrives

Scopesthreads:readNeeds a sign-in

Usage

nextmail analytics mailbox [flags]

Resolves how mail arrives, as the Analytics page of the app shows it, for a window, the last 30 days unless from and to say otherwise: how many conversations arrived and when, per grain bucket in days and per hour of the day in hours, the addresses they arrived at, the senders who wrote most, how many conversations wait on a reply for 1, 3 or 7 days or more, and the folders.

days is sparse: a bucket in which nothing arrived has no entry, so a chart must fill the gaps. --offset-minutes shifts the boundaries so days and hours break where the reader's do, and series holds the per bucket counts of the top addresses and senders so each can be charted.

A key limited to particular addresses counts only the mail that arrived at them, and address narrows everything to one address. An address the key does not reach counts nothing rather than failing.

Flags

--from <when>

The start of the window. Defaults to 30 days before to.

--to <when>

The end of the window. Defaults to now.

--offset-minutes <n>

Minutes east of UTC, from -840 to 840, defaulting to 0. Pass -new Date().getTimezoneOffset() for the local zone.

Default0
--grain <value>

Bucket width: minute, hour or day, defaulting to day.

Default"day"
--address <value>

Count only the mail delivered to this address.

Examples

nextmail analytics mailbox
Print the raw JSON
nextmail analytics mailbox --json

Also available in

API
GET /analytics/mailbox
TypeScript
nextmail.analytics.mailbox()
Python
analytics.mailbox()
Ruby
analytics.mailbox
PHP
analytics->mailbox
Go
Analytics.Mailbox
Java
analytics().mailbox
C#
Analytics.MailboxAsync

nextmail analytics sending

Read what became of sent mail

Scopesemails:readNeeds a sign-in

Usage

nextmail analytics sending [flags]

Resolves the numbers behind the Analytics page of the app: what the workspace sent inside a window and what became of it. totals adds up the sends, recipients and test sends and how many were delivered, failed, bounced, complained about, uncertain or still pending, days cuts sent, delivered, failed, bounced and complained to grain buckets, and statuses, sources, streams, senders and suppressed break the window down.

The window is days, 30 by default and at most 365, or minutes, which wins when both are sent. It ends at until, now by default, and starts at since when that is sent, or else at the beginning of its oldest bucket. Both come back as since and until. --offset-minutes shifts the bucket boundaries so days break where the reader's do.

A key limited to particular addresses counts only the mail sent from them, and address narrows everything to one address. recipient and tag narrow it further, to the mail that went to one address or carried one tag.

Flags

--days <n>

Window length in days, from 1 to 365, defaulting to 30.

Default30
--minutes <n>

Window length in minutes, which wins over days.

--offset-minutes <n>

Minutes east of UTC, from -840 to 840, defaulting to 0.

Default0
--grain <value>

Bucket width: minute, hour or day, defaulting to day.

Default"day"
--address <value>

Count only the mail sent from this address.

--since <when>

Start of the window, which wins over days and minutes. A window spans at most 365 days.

--until <when>

End of the window, not included, defaulting to now. since after until is a 422 invalid_parameter.

--recipient <value>

Count only the mail that went to this address, and only its delivery to that address.

--tag <value>

Count only the mail sent with this tag: name for any value, or name:value for one value.

Examples

nextmail analytics sending
With optional flags
nextmail analytics sending --days 7
Print the raw JSON
nextmail analytics sending --json

Also available in

API
GET /analytics/sending
TypeScript
nextmail.analytics.sending()
Python
analytics.sending()
Ruby
analytics.sending
PHP
analytics->sending
Go
Analytics.Sending
Java
analytics().sending
C#
Analytics.SendingAsync