---
title: "Get email reporting overview"
method: POST
path: "/v3/reporting/emails/overview"
tags: ["Reports"]
---

# Get email reporting overview

`POST /v3/reporting/emails/overview`

<small>_Requires the `reporting:read` scope (or a broader one that includes it)._</small>

Returns email delivery and engagement metrics with optional trend comparison.

Provides aggregated statistics including delivery rates, opens, replies, bounces, and clicks.
Optionally compare against a previous period by providing the `compareTo` field.

## Request body

- object — Request body for email overview reporting with optional comparison period
  - `filters` object, required — Filters specific to email reporting endpoints
    - `from` string, date-time — Start date of the reporting period
    - `to` string, date-time — End date of the reporting period
    - `dateRangePreset` 'lastWeek' | 'lastMonth' | 'lastYear' | 'allTime' — Predefined date range shortcut. Defaults to lastWeek when neither dateRangePreset nor from/to are provided. Use allTime to retrieve the full historical report. Cannot be combined with from/to.
    - `teamIds` integer[] — Filter by team IDs
    - `userIds` integer[] — Filter by user IDs
    - `contactListIds` integer[] — Filter by contact list IDs
    - `emailValidationStatuses` string[] — Filter by email validation status
    - `companies` string[] — Filter by company names
    - `companySizes` string[] — Filter by company size ranges
    - `industries` string[] — Filter by industry names
    - `cities` string[] — Filter by city names
    - `states` string[] — Filter by state/region names
    - `countries` string[] — Filter by country names
    - `titles` string[] — Filter by job titles
    - `sequenceIds` integer[] — Filter by sequence IDs
    - `includeOutOfSequence` boolean — Include activity outside of sequences
    - `emailProviders` string[] — Filter by email provider type
    - `emailAccountIds` integer[] — Filter by email account IDs
    - `emailSendingSources` string[] — Filter by email sending source
    - `bounceTypes` string[] — Filter by bounce type
    - `sentiments` string[] — Filter by reply sentiment category
  - `compareTo` object — Optional comparison period to calculate trends against
    - `from` string, date-time — Start date of the comparison period
    - `to` string, date-time — End date of the comparison period

## Response `200`

Email overview with trends retrieved successfully

- object — Email delivery and engagement metrics
  - `contacted` integer — Number of people contacted
  - `delivered` integer — Number of emails delivered
  - `opened` integer — Number of emails opened
  - `replied` integer — Number of emails replied to
  - `interested` integer — Number of replies marked as interested
  - `notReached` integer — Number of contacts not reached
  - `optedOut` integer — Number of opt-outs
  - `outOfOffice` integer — Number of out-of-office replies
  - `bounced` integer — Number of bounced emails
  - `autoReplied` integer — Number of auto-replies received
  - `meetingsBooked` integer — Number of meetings booked from emails
  - `accounts` integer, nullable — Total number of email accounts used
  - `deliveredPercentage` number, double — Delivery rate as a percentage (0–100)
  - `openedPercentage` number, double — Open rate as a percentage (0–100)
  - `repliedPercentage` number, double — Reply rate as a percentage (0–100)
  - `interestedPercentage` number, double — Interested rate as a percentage (0–100)
  - `notReachedPercentage` number, double — Not-reached rate as a percentage (0–100)
  - `optedOutPercentage` number, double — Opt-out rate as a percentage (0–100)
  - `outOfOfficePercentage` number, double — Out-of-office rate as a percentage (0–100)
  - `bouncedPercentage` number, double — Bounce rate as a percentage (0–100)
  - `autoRepliedPercentage` number, double — Auto-reply rate as a percentage (0–100)
  - `meetingsBookedPercentage` number, double — Meetings booked rate as a percentage (0–100)

## Other responses

- `400` — Request-body validation failure (FluentValidator).
- `401` — Unauthorized. The response body is empty; check the `WWW-Authenticate` header for the expected scheme.
- `403` — User lacks required feature scope to view reports.
- `429` — Too Many Requests

---

[API](https://skmtc.net/reply/apis/reply-api.md) · [All operations](https://skmtc.net/reply/apis/reply-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reply/reply-api/revisions/1c3d32eaf95e/schema)