Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Reports

Get email reporting 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.

post/v3/reporting/emails/overview

Request body

Example request

{
  "filters": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-03-01T00:00:00Z"
  },
  "compareTo": {
    "from": "2025-12-01T00:00:00Z",
    "to": "2025-12-31T00:00:00Z"
  }
}

Response

Email overview with trends retrieved successfully

contactedinteger

Number of people contacted

deliveredinteger

Number of emails delivered

openedinteger

Number of emails opened

repliedinteger

Number of emails replied to

interestedinteger

Number of replies marked as interested

notReachedinteger

Number of contacts not reached

optedOutinteger

Number of opt-outs

outOfOfficeinteger

Number of out-of-office replies

bouncedinteger

Number of bounced emails

autoRepliedinteger

Number of auto-replies received

meetingsBookedinteger

Number of meetings booked from emails

accountsinteger nullable

Total number of email accounts used

deliveredPercentagenumber double

Delivery rate as a percentage (0–100)

openedPercentagenumber double

Open rate as a percentage (0–100)

repliedPercentagenumber double

Reply rate as a percentage (0–100)

interestedPercentagenumber double

Interested rate as a percentage (0–100)

notReachedPercentagenumber double

Not-reached rate as a percentage (0–100)

optedOutPercentagenumber double

Opt-out rate as a percentage (0–100)

outOfOfficePercentagenumber double

Out-of-office rate as a percentage (0–100)

bouncedPercentagenumber double

Bounce rate as a percentage (0–100)

autoRepliedPercentagenumber double

Auto-reply rate as a percentage (0–100)

meetingsBookedPercentagenumber double

Meetings booked rate as a percentage (0–100)