Skip to main content
GET
Get Group Aggregate Stats

Authorizations

X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Path Parameters

subaccount_id
integer<int64>
required

The ID of the subaccount to retrieve

Example:

11

Query Parameters

group
string
required

The group/tag name to filter statistics by. Must match the group name used when sending emails.

Example:

"order-confirmations"

from
string<date>
required

Start date for aggregation (inclusive). Format YYYY-MM-DD.

Example:

"2024-01-01"

to
string<date>
required

The ending date for the aggregated stats (Note: from should be earlier than to and the date range should not exceed 366 days)

Response

200 - application/json

Aggregated email stats for the group within the specified date range

Aggregated email statistics over a date range. Inherits all fields from Stat schema with the same meanings.

processed
integer<int64>

Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API.

Example:

225

sent
integer<int64>

Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped

Example:

220

dropped
integer<int64>

Number of emails dropped before sending. Common reasons:

  • Recipient email in suppression list (hard bounce, spam complaint, unsubscribe)
  • Invalid recipient email format
  • Sender domain not verified
Example:

10

smtpDropped
integer<int64>

Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed.

Example:

5

delivered
integer<int64>

Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox.

Example:

200

softBounced
integer<int64>

Number of temporary delivery failures (soft bounces). Common causes:

  • Recipient mailbox full
  • Server temporarily unavailable
  • Message too large SendPost automatically retries soft bounces.
Example:

5

hardBounced
integer<int64>

Number of permanent delivery failures (hard bounces). Common causes:

  • Recipient email doesn't exist
  • Domain doesn't exist
  • Recipient has blocked sender Hard bounced addresses are automatically added to suppression list.
Example:

10

opened
integer<int64>

Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels.

Example:

150

clicked
integer<int64>

Number of emails with at least one link clicked. Requires trackClicks=true.

Example:

50

unsubscribed
integer<int64>

Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list.

Example:

6

spam
integer<int64>

Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%.

Example:

2