> ## 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 stats for all sequences
> _Requires the `sequences:read` scope (or a broader one that includes it)._
Returns email and LinkedIn engagement stats per sequence.
**Date range restrictions:**
- `dateRangePreset` must be `lastWeek` or `lastMonth`. `lastYear` and `allTime` are rejected.
- When using `from`/`to`, the span must not exceed 31 days.
- `from` must be within the last 31 days from the current date.
- Defaults to `lastWeek` if no date filters are provided.
## OpenAPI
````yaml /api-reference/bundled.yaml post /v3/sequences/stats
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/sequences/stats:
post:
tags:
- Sequences
summary: Get stats for all sequences
description: >-
_Requires the `sequences:read` scope (or a broader one that
includes it)._
Returns email and LinkedIn engagement stats per sequence.
**Date range restrictions:**
- `dateRangePreset` must be `lastWeek` or `lastMonth`. `lastYear` and
`allTime` are rejected.
- When using `from`/`to`, the span must not exceed 31 days.
- `from` must be within the last 31 days from the current date.
- Defaults to `lastWeek` if no date filters are provided.
operationId: GetSequenceStatsList
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filters:
type: object
description: >-
Date range filters for sequence stats list.
**Restrictions:** Date range is limited to one month
maximum.
- `dateRangePreset` must be `lastWeek` or `lastMonth`.
`lastYear` and `allTime` are rejected.
- When using `from`/`to`, the span must not exceed 31 days.
- `from` must be within the last 31 days from the current
date.
properties:
from:
type: string
format: date-time
description: Start date. Must be within the last 31 days.
to:
type: string
format: date-time
description: End date. Range from `from` must not exceed 31 days.
dateRangePreset:
type: string
enum:
- lastWeek
- lastMonth
description: >-
Predefined date range. Cannot be combined with from/to.
Defaults to `lastWeek` if no dates provided.
Only `lastWeek` and `lastMonth` are allowed on this
endpoint.
userIds:
type: array
items:
type: integer
description: Filter by user IDs
responses:
'200':
description: Sequence stats list retrieved successfully
content:
application/json:
schema:
type: array
items:
type: object
title: Sequence Stats List Item Response
description: Email and LinkedIn stats for a single sequence in the list
properties:
sequenceId:
type: integer
description: Sequence ID
name:
type: string
description: Sequence name
status:
type: string
enum:
- new
- active
- paused
- archived
description: Current sequence status
emailOverview:
type: object
title: Sequence Email Overview
description: Email engagement metrics for a sequence
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
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)
linkedInOverview:
type: object
title: Sequence LinkedIn Overview
description: LinkedIn engagement metrics for a sequence
properties:
connectionsSent:
type: integer
description: Number of connection requests sent
connectionsAccepted:
type: integer
description: Number of connection requests accepted
connectionsAcceptedPercentage:
type: number
format: double
description: Connection acceptance rate as a percentage (0–100)
messagesSent:
type: integer
description: Number of LinkedIn messages sent
replied:
type: integer
description: Number of message replies received
repliedPercentage:
type: number
format: double
description: Message reply rate as a percentage (0–100)
inMailsSent:
type: integer
description: Number of InMails sent
inMailsReplied:
type: integer
description: Number of InMail replies received
inMailsRepliedPercentage:
type: number
format: double
description: InMail reply rate as a percentage (0–100)
connectionNotesSent:
type: integer
description: Number of connection notes sent
connectionNotesReplied:
type: integer
description: Number of connection note replies received
connectionNotesRepliedPercentage:
type: number
format: double
description: Connection notes reply rate as a percentage (0–100)
profileViews:
type: integer
description: Number of profile views
likes:
type: integer
description: Number of likes
follows:
type: integer
description: Number of follows
endorses:
type: integer
description: Number of endorsements
regularMessagesSent:
type: integer
description: Number of regular messages sent
regularMessagesReplied:
type: integer
description: Number of regular message replies received
regularMessagesRepliedPercentage:
type: number
format: double
description: Regular messages reply rate as a percentage (0–100)
'400':
description: >-
Request-body validation failure (FluentValidator) — including
date-range
restriction violations.
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
detail: Date range must not exceed 31 days.
'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 sequence stats.
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: sequenceStats.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**.
````