> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reply.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get email reporting overview
> _Requires the `reporting:read` scope (or a broader one that includes it)._
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.
## OpenAPI
````yaml /api-reference/bundled.yaml post /v3/reporting/emails/overview
openapi: 3.1.0
info:
version: 3.0.0
title: Reply API
description: API for managing email sequences, contacts, and automation workflows
servers:
- url: https://api.reply.io
security:
- bearerAuth: []
tags:
- name: User Account
description: Account information and authentication verification
- name: Accounts
description: Manage accounts (companies/organizations)
- name: AI SDR Insights
description: Read AI SDR insights for sequence contacts
- name: AI SDR Intent Signals
description: >-
Read Reply industry IDs and technology slugs used in AI SDR intent-signal
configuration (typeahead)
- name: AI SDR Sequences
description: >-
Manage AI SDR sequences and their AI SDR-specific settings — create, read
settings, partial update, autopilot enable/disable/force-start, approval
mode, generated step types, and playbook/knowledge-base connections
- name: AI SDR Web Search
description: Find contacts via AI-driven web search and review past searches
- name: Attachments
description: >-
Upload file attachments used across email templates, sequence steps, and
direct emails
- name: Account Lists
description: Manage account lists and account membership
- name: Background Jobs
description: >-
Track and cancel asynchronous background operations (e.g., email
validation)
- name: Custom Fields
description: Manage custom contact fields
- name: Direct Outreach
description: >-
Send one-off outreach directly to a contact outside of any sequence —
direct emails and LinkedIn connection requests, messages, InMails, and
voice messages
- name: Contact Blacklist Rules
description: Manage blacklist rules for domains, emails, and email exceptions
- name: Contact Enrichment
description: >-
Enrich contacts with emails, phone numbers, LinkedIn data, and AI-filled
custom fields
- name: Contact Lists
description: Manage contact lists and contact membership
- name: Contacts
description: Manage individual contacts
- name: Email Accounts
description: Manage email accounts used for sending and receiving
- name: Email Templates
description: Manage email templates and template folders
- name: Email Validations
description: Estimate and schedule asynchronous email validation jobs
- name: Holiday Calendars
description: Manage holiday calendars for scheduling
- name: Inbox
description: >-
Manage inbox threads and per-team thread categories — list/filter, read
state, replies, category assignment, and meeting-intent flagging
- name: LinkedIn Accounts
description: Manage LinkedIn accounts for outreach
- name: Live Data
description: >-
Find new contacts via Live Data searches and read typeahead values for the
Live Data / Autopilot filter sidebar
- name: AI SDR Knowledge Bases
description: >-
Manage AI SDR knowledge bases — collections of documents, links, reply
handlers, and reengagement cards that inform the agent's responses
- name: AI SDR Offers
description: >-
Manage AI SDR offers — bundles of company-context inputs (ICP, pain
points, value propositions, etc.) used to personalize outreach
- name: AI SDR Pending Approvals
description: >-
Review, send, regenerate, and provide feedback on AI-generated messages
awaiting human approval
- name: AI SDR Playbooks
description: >-
Manage AI SDR playbooks — tone, voice, and style guides applied during
personalized message generation
- name: Reports
description: >-
Generate and access performance reports across email, calls, tasks,
LinkedIn, and team performance
- name: Schedules
description: Manage email send schedules and timing
- name: Settings
description: Manage team and user settings
- name: Sequence Contacts
description: Manage contacts within sequences
- name: Sequence Email Accounts
description: Manage email accounts linked to sequences
- name: Sequence Folders
description: Organize sequences into folders
- name: Sequence LinkedIn Accounts
description: Manage LinkedIn accounts linked to sequences
- name: AI SDR Sequence Preview
description: >-
Read and regenerate per-contact previews of the messages a sequence will
send, and provide feedback on preview messages
- name: Sequence Steps
description: Manage individual steps in sequences
- name: Sequence Templates
description: Manage sequence templates
- name: Sequences
description: Manage email automation sequences
- name: AI SDR Strategist
description: Trigger AI Strategist runs
- name: Tasks
description: Manage tasks and to-do items
- name: Webhooks
description: Manage webhook subscriptions and inspect delivery history
paths:
/v3/reporting/emails/overview:
post:
tags:
- Reports
summary: Get email reporting overview
description: >-
_Requires the `reporting:read` scope (or a broader one that
includes it)._
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.
operationId: GetEmailsOverview
requestBody:
required: true
content:
application/json:
schema:
type: object
title: Email Reporting Overview Request
description: >-
Request body for email overview reporting with optional
comparison period
required:
- filters
properties:
filters:
allOf:
- type: object
title: Reporting Filters
description: Base filters shared across all reporting endpoints
properties:
from:
type: string
format: date-time
description: Start date of the reporting period
example: '2026-01-01T00:00:00Z'
to:
type: string
format: date-time
description: End date of the reporting period
example: '2026-03-01T00:00:00Z'
dateRangePreset:
type: string
description: >-
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.
enum:
- lastWeek
- lastMonth
- lastYear
- allTime
default: lastWeek
teamIds:
type: array
items:
type: integer
description: Filter by team IDs
userIds:
type: array
items:
type: integer
description: Filter by user IDs
contactListIds:
type: array
items:
type: integer
description: Filter by contact list IDs
emailValidationStatuses:
type: array
items:
type: string
enum:
- requiresValidation
- valid
- notValid
- risky
- validationFailed
- catchAll
description: Filter by email validation status
companies:
type: array
items:
type: string
description: Filter by company names
companySizes:
type: array
items:
type: string
enum:
- empty
- selfEmployed
- ten
- fifty
- twoHundred
- fiveHundred
- oneThousand
- fiveThousand
- tenThousand
- overTenThousand
description: Filter by company size ranges
industries:
type: array
items:
type: string
description: Filter by industry names
cities:
type: array
items:
type: string
description: Filter by city names
states:
type: array
items:
type: string
description: Filter by state/region names
countries:
type: array
items:
type: string
description: Filter by country names
titles:
type: array
items:
type: string
description: Filter by job titles
sequenceIds:
type: array
items:
type: integer
description: Filter by sequence IDs
includeOutOfSequence:
type: boolean
description: Include activity outside of sequences
default: false
emailProviders:
type: array
items:
type: string
enum:
- none
- other
- gSuite
- office
- zoho
- mimecast
- proofpoint
- yandex
- ovh
- goDaddy
- ionos
- gandi
- hostinger
- oneAndOne
- amazon
- unknown
- barracuda
- spamexperts
- hotmail
- liveCom
- yahoo
- bloomberg
- gmail
- outlook
- ciscoSecureEmail
- titanMail
- protonmail
- namecheap
- appleMail
- linkedin
description: Filter by email provider type
- type: object
title: Email Reporting Filters
description: Filters specific to email reporting endpoints
properties:
emailAccountIds:
type: array
items:
type: integer
format: int64
description: Filter by email account IDs
emailSendingSources:
type: array
items:
type: string
enum:
- sequenceProcessing
- manualEmail
description: Filter by email sending source
bounceTypes:
type: array
items:
type: string
enum:
- unknown
- soft
- hard
- gmailApiLimitWarning
- office365LimitWarning
- mailboxFull
- authenticationFailure
- spamRejection
- policyViolation
description: Filter by bounce type
sentiments:
type: array
items:
type: string
enum:
- unknown
- interested
- notInterested
- doNotContact
- notNow
- forwarded
- meeting
description: Filter by reply sentiment category
compareTo:
type: object
description: Optional comparison period to calculate trends against
properties:
from:
type: string
format: date-time
description: Start date of the comparison period
example: '2025-12-01T00:00:00Z'
to:
type: string
format: date-time
description: End date of the comparison period
example: '2025-12-31T00:00:00Z'
responses:
'200':
description: Email overview with trends retrieved successfully
content:
application/json:
schema:
type: object
title: Emails Overview Response
description: Email delivery and engagement metrics
properties:
contacted:
type: integer
description: Number of people contacted
delivered:
type: integer
description: Number of emails delivered
opened:
type: integer
description: Number of emails opened
replied:
type: integer
description: Number of emails replied to
interested:
type: integer
description: Number of replies marked as interested
notReached:
type: integer
description: Number of contacts not reached
optedOut:
type: integer
description: Number of opt-outs
outOfOffice:
type: integer
description: Number of out-of-office replies
bounced:
type: integer
description: Number of bounced emails
autoReplied:
type: integer
description: Number of auto-replies received
meetingsBooked:
type: integer
description: Number of meetings booked from emails
accounts:
type: integer
nullable: true
description: Total number of email accounts used
deliveredPercentage:
type: number
format: double
description: Delivery rate as a percentage (0–100)
openedPercentage:
type: number
format: double
description: Open rate as a percentage (0–100)
repliedPercentage:
type: number
format: double
description: Reply rate as a percentage (0–100)
interestedPercentage:
type: number
format: double
description: Interested rate as a percentage (0–100)
notReachedPercentage:
type: number
format: double
description: Not-reached rate as a percentage (0–100)
optedOutPercentage:
type: number
format: double
description: Opt-out rate as a percentage (0–100)
outOfOfficePercentage:
type: number
format: double
description: Out-of-office rate as a percentage (0–100)
bouncedPercentage:
type: number
format: double
description: Bounce rate as a percentage (0–100)
autoRepliedPercentage:
type: number
format: double
description: Auto-reply rate as a percentage (0–100)
meetingsBookedPercentage:
type: number
format: double
description: Meetings booked rate as a percentage (0–100)
'400':
description: Request-body validation failure (FluentValidator).
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
errors:
type: array
description: >-
List of field-level validation errors. Always
non-empty when this
envelope is returned. Each entry pins a single
offending field
via JSON Pointer plus a sanitized detail string.
items:
type: object
title: Validation Error
description: A single field-level validation error.
properties:
pointer:
type: string
description: >-
JSON Pointer (RFC 6901) to the offending
field — e.g.
`/steps/0/subject`.
* An empty string (`""`) means the error
applies to the whole
request body (e.g. body is missing or unparseable).
* For route or query parameter failures the
pointer is the parameter
name (e.g. `id`, `top`).
example: /steps/0/subject
detail:
type: string
description: >-
Sanitized, human-readable explanation of
this field's error. One of a
small set of templates — `"Field is
required."`, `"Value has an
invalid type."`, `"Value has an invalid
format."`, `"Request body is
not valid JSON."`, `"The request body is
required and cannot be
empty."` — or a FluentValidator message on
body endpoints.
example: Field is required.
title: Validation Problem
description: >-
Input-validation error response at 400. Returned when the
request body
fails binding, FluentValidator rules, or when route/query
parameter
attribute validation (`[Range]`, `[Required]`) fails.
Route, query, and
body errors are combined into a single `errors[]` array —
clients should
not assume one error per request.
- example:
title: Validation failed
status: 400
detail: The request body contains validation errors.
errors:
- pointer: /name
detail: Field is required.
example:
title: Validation failed
status: 400
detail: The request body contains validation errors.
errors:
- pointer: /filters/from
detail: '''from'' must be a valid ISO 8601 date.'
'401':
description: >-
Unauthorized. The response body is empty; check the
`WWW-Authenticate` header for the expected scheme.
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- example:
title: Unauthorized
status: 401
detail: Authentication credentials are missing or invalid.
'403':
description: User lacks required feature scope to view reports.
content:
application/problem+json:
schema:
allOf:
- allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized
(auth middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope
and add additional
fields — see `business-problem.model.yaml` (adds
`code` slug) and
`validation-problem.model.yaml` (adds `errors[]`
array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
- type: object
properties:
code:
type: string
description: >-
Stable, machine-readable error slug in the form
`"."`.
* `resource` is the camelCased domain — e.g.
`sequence`,
`contact`, `inboxThread`, `blacklistDomainRule`.
* `variant` is the camelCased specific failure
mode — e.g.
`notFound`, `forbidden`, `duplicateName`, `globalRuleReadOnly`.
Use `code` for programmatic error handling; use
`detail` for
user-facing messages. Slugs are stable across
server-side enum
reorderings and never change meaning under a given
resource.
pattern: ^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$
example: sequence.notFound
title: Business Problem
description: >-
Domain error response carrying a stable, namespaced error
slug.
Emitted for most 4xx responses (business 400, 403, 404,
409, …) and
for 503 when a downstream dependency is unavailable.
- example:
title: Forbidden
status: 403
detail: You do not have permission to access this resource.
code: sequence.forbidden
example:
title: Forbidden
status: 403
detail: Feature scopes [ViewReports] are denied for userId 123.
code: reports.forbidden
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
minimum: 1
content:
application/problem+json:
schema:
allOf:
- type: object
title: Problem Details
description: >-
Bare RFC 9457 problem-details envelope. Returned by
middleware-level errors
that don't carry domain context: 401 Unauthorized (auth
middleware),
429 Too Many Requests (rate-limit middleware), and
route-level 404 / 405 /
415 (framework middleware).
Business and validation responses extend this envelope and
add additional
fields — see `business-problem.model.yaml` (adds `code`
slug) and
`validation-problem.model.yaml` (adds `errors[]` array).
properties:
title:
type: string
description: Short, human-readable summary of the problem.
status:
type: integer
description: HTTP status code.
minimum: 100
maximum: 599
detail:
type: string
description: >-
Human-readable explanation specific to this
occurrence.
example:
title: Too Many Requests
status: 429
detail: Rate limit exceeded. Retry after 60 seconds.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Authenticate every request with a Bearer token. Pass your Reply API key
in the
`Authorization` header:
```
Authorization: Bearer
```
Get your API key from the Reply dashboard: **Settings → API Key**.
````