---
title: "openemail analytics"
description: "Every command in this namespace, with its arguments, flags and examples."
url: "https://openemail.uk/docs/cli/reference/analytics"
area: "CLI"
category: "Reference"
---

# openemail analytics

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

## Commands

### `openemail analytics mailbox`

Read how mail arrives

```bash
openemail 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.

- Scopes: `threads:read`.
- Needs a sign-in.

**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>` (default `0`): Minutes east of UTC, from -840 to 840, defaulting to 0. Pass `-new Date().getTimezoneOffset()` for the local zone.
- `--grain <value>` (default `"day"`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`.
- `--address <value>`: Count only the mail delivered to this address.

**Examples**

```bash
openemail analytics mailbox
```

Print the raw JSON

```bash
openemail analytics mailbox --json
```

Also available in: API [`GET /analytics/mailbox`](https://openemail.uk/docs/api/reference/analytics#get-analytics-mailbox); SDK [`analytics.mailbox()`](https://openemail.uk/docs/sdk/reference/analytics#mailbox).

### `openemail analytics sending`

Read what became of sent mail

```bash
openemail 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`, `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 now, reported as `until`, and starts at the beginning of its oldest bucket, reported as `since`. `--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.

- Scopes: `emails:read`.
- Needs a sign-in.

**Flags**

- `--days <n>` (default `30`): Window length in days, from 1 to 365, defaulting to 30.
- `--minutes <n>`: Window length in minutes, which wins over `days`.
- `--offset-minutes <n>` (default `0`): Minutes east of UTC, from -840 to 840, defaulting to 0.
- `--grain <value>` (default `"day"`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`.
- `--address <value>`: Count only the mail sent from this address.

**Examples**

```bash
openemail analytics sending
```

With optional flags

```bash
openemail analytics sending --days 7
```

Print the raw JSON

```bash
openemail analytics sending --json
```

Also available in: API [`GET /analytics/sending`](https://openemail.uk/docs/api/reference/analytics#get-analytics-sending); SDK [`analytics.sending()`](https://openemail.uk/docs/sdk/reference/analytics#sending).