Skip to main content
POST
/
reporting
/
emails
/
overview
Get email reporting overview
curl --request POST \
  --url https://api.reply.io/v3/reporting/emails/overview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "filters": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-03-01T00:00:00Z",
    "dateRangePreset": "LastWeek",
    "teamIds": [
      123
    ],
    "userIds": [
      123
    ],
    "contactListIds": [
      123
    ],
    "emailValidationStatuses": [
      "RequiresValidation"
    ],
    "companies": [
      "<string>"
    ],
    "companySizes": [
      "Empty"
    ],
    "industries": [
      "<string>"
    ],
    "cities": [
      "<string>"
    ],
    "states": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "titles": [
      "<string>"
    ],
    "sequenceIds": [
      123
    ],
    "includeOutOfSequence": false,
    "emailProviders": [
      "None"
    ],
    "emailAccountIds": [
      123
    ],
    "emailSendingSources": [
      "SequenceProcessing"
    ],
    "bounceTypes": [
      "Unknown"
    ],
    "sentiments": [
      "Unknown"
    ]
  },
  "compareTo": {
    "from": "2025-12-01T00:00:00Z",
    "to": "2025-12-31T00:00:00Z"
  }
}
'
{
  "delivered": 123,
  "opened": 123,
  "replied": 123,
  "interested": 123,
  "notReached": 123,
  "optOutsRate": 123,
  "outOfOffice": 123,
  "bounced": 123,
  "autoReplied": 123,
  "meetingsBooked": 123,
  "deliveredPercentage": 123,
  "openedPercentage": 123,
  "repliedPercentage": 123,
  "optOutsRatePercentage": 123,
  "notReachedPercentage": 123,
  "interestedPercentage": 123,
  "outOfOfficePercentage": 123,
  "bouncedPercentage": 123,
  "autoRepliedPercentage": 123,
  "meetingsBookedPercentage": 123,
  "totalPeopleCount": 123,
  "contacted": 123,
  "totalAccounts": 123,
  "trends": {
    "total": 123,
    "contacted": 123,
    "deliveryRate": 123,
    "openRate": 123,
    "replyRate": 123,
    "interested": 123,
    "meetingsBooked": 123,
    "optOutRate": 123,
    "notReached": 123,
    "bounceRate": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json

Request body for email overview reporting with optional comparison period

filters
Email Reporting Filters · object
required

Filters specific to email reporting endpoints

compareTo
object

Optional comparison period to calculate trends against

Response

Email overview with trends retrieved successfully

Email delivery and engagement metrics with optional trend comparison

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

optOutsRate
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

deliveredPercentage
number<double>

Delivery rate as a percentage

openedPercentage
number<double>

Open rate as a percentage

repliedPercentage
number<double>

Reply rate as a percentage

optOutsRatePercentage
number<double>

Opt-out rate as a percentage

notReachedPercentage
number<double>

Not-reached rate as a percentage

interestedPercentage
number<double>

Interested rate as a percentage

outOfOfficePercentage
number<double>

Out-of-office rate as a percentage

bouncedPercentage
number<double>

Bounce rate as a percentage

autoRepliedPercentage
number<double>

Auto-reply rate as a percentage

meetingsBookedPercentage
number<double>

Meetings booked rate as a percentage

totalPeopleCount
integer

Total number of people in the report

contacted
integer

Number of people contacted

totalAccounts
integer

Total number of email accounts used

Trend comparison against the compareTo period (present only when compareTo is provided)