---
title: "client.analytics"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/ruby/reference/analytics"
area: "Ruby"
category: "Reference"
---

# client.analytics

Every method in this namespace: its signature, its parameters, what it returns and an example.

## Methods

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

### `analytics.mailbox`

Read how mail arrives

```ruby
mailbox(from: nil, to: nil, offset_minutes: nil, grain: nil, address: nil, api_key: nil) -> Hash
```

Returns 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`.

**Parameters**

- `from` (`Time, Date or String`): The start of the window. Defaults to 30 days before `to:`.
- `to` (`Time, Date or String`): The end of the window. Defaults to now.
- `offset_minutes` (`Integer`): Minutes east of UTC, from -840 to 840, defaulting to 0. Pass `Time.now.utc_offset / 60` for the local zone.
- `grain` (`String`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`.
- `address` (`String`): Count only the mail delivered to this address.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `mailbox_insights`, `from`, `to`, `grain`, `offsetMinutes`, `scanned`, `days`, `hours`, `addresses`, `senders`, `senderCount`, `waiting`, `unattributed`, `folders` and `series`.

**Example**

```ruby
insights = client.analytics.mailbox(offset_minutes: Time.now.utc_offset / 60)

puts "#{insights[:scanned]} conversations from #{insights[:senderCount]} senders"

insights[:senders].each { |sender| puts "#{sender[:email]} #{sender[:count]}" }
```

**Notes**

- Read only, so the SDK retries it after a network failure like any other read.
- `from:` after `to:` is a 422 `invalid_parameter`.

Also available in: API [`GET /analytics/mailbox`](https://nextmail.sh/docs/api/reference/analytics#get-analytics-mailbox); TypeScript [`nextmail.analytics.mailbox()`](https://nextmail.sh/docs/sdk/reference/analytics#mailbox); Python [`analytics.mailbox()`](https://nextmail.sh/docs/python/reference/analytics#mailbox); PHP [`analytics->mailbox`](https://nextmail.sh/docs/php/reference/analytics#mailbox); Go [`Analytics.Mailbox`](https://nextmail.sh/docs/go/reference/analytics#mailbox); Java [`analytics().mailbox`](https://nextmail.sh/docs/java/reference/analytics#mailbox); C# [`Analytics.MailboxAsync`](https://nextmail.sh/docs/csharp/reference/analytics#mailbox); CLI [`nextmail analytics mailbox`](https://nextmail.sh/docs/cli/reference/analytics#analytics-mailbox).

### `analytics.sending`

Read what became of sent mail

```ruby
sending(days: nil, minutes: nil, offset_minutes: nil, grain: nil, address: nil, since: nil, until: nil, recipient: nil, tag: nil, api_key: nil) -> Hash
```

Returns 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.

Scopes: `emails:read`.

**Parameters**

- `days` (`Integer`): Window length in days, from 1 to 365, defaulting to 30.
- `minutes` (`Integer`): Window length in minutes, which wins over `days:`.
- `offset_minutes` (`Integer`): Minutes east of UTC, from -840 to 840, defaulting to 0.
- `grain` (`String`): Bucket width: `minute`, `hour` or `day`, defaulting to `day`.
- `address` (`String`): Count only the mail sent from this address.
- `since` (`Time, DateTime or String`): Start of the window, which wins over `days:` and `minutes:`. A window spans at most 365 days.
- `until` (`Time, DateTime or String`): End of the window, not included, defaulting to now. `since:` after `until:` is a 422 `invalid_parameter`.
- `recipient` (`String`): Count only the mail that went to this address, and only its delivery to that address.
- `tag` (`String`): Count only the mail sent with this tag: `name` for any value, or `name:value` for one value.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `sending_analytics`, `since`, `until`, `grain`, `offsetMinutes`, `totals`, `days`, `statuses`, `sources`, `streams`, `senders` and `suppressed`.

**Example**

```ruby
analytics = client.analytics.sending(days: 7)

sends, delivered, bounced = analytics[:totals].values_at(:sends, :delivered, :bounced)

puts "#{delivered} of #{sends} delivered, #{bounced} bounced"
```

**Notes**

- Read only, so the SDK retries it after a network failure like any other read.

Also available in: API [`GET /analytics/sending`](https://nextmail.sh/docs/api/reference/analytics#get-analytics-sending); TypeScript [`nextmail.analytics.sending()`](https://nextmail.sh/docs/sdk/reference/analytics#sending); Python [`analytics.sending()`](https://nextmail.sh/docs/python/reference/analytics#sending); PHP [`analytics->sending`](https://nextmail.sh/docs/php/reference/analytics#sending); Go [`Analytics.Sending`](https://nextmail.sh/docs/go/reference/analytics#sending); Java [`analytics().sending`](https://nextmail.sh/docs/java/reference/analytics#sending); C# [`Analytics.SendingAsync`](https://nextmail.sh/docs/csharp/reference/analytics#sending); CLI [`nextmail analytics sending`](https://nextmail.sh/docs/cli/reference/analytics#analytics-sending).