Skip to main content
GET
/
account
/
stat
/
aggregate
/
group
Get Account Aggregate Stats by Group
curl --request GET \
  --url https://api.sendpost.io/api/v1/account/stat/aggregate/group \
  --header 'X-Account-ApiKey: <api-key>'
{
  "processed": 225,
  "delivered": 200,
  "dropped": 10,
  "hardBounced": 10,
  "softBounced": 5,
  "unsubscribed": 6,
  "spam": 2
}

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Query Parameters

​
group
string
required

Group whose aggregate stats need to be retrieved.

Example:

"shopify"

​
from
string<date>
required

Date from which stats should be retrieved (should be in the format YYYY-MM-DD).

Example:

"2019-01-01"

​
to
string<date>
required

Date to which stats should be retrieved (should be in the format YYYY-MM-DD). Note that the difference between from and to should not be more than 366 days.

Example:

"2019-12-31"

Response

Successfully retrieved aggregate stats by group.

​
processed
integer

Number of emails accepted by SendPost API.

Example:

225

​
delivered
integer

Number of emails we were able to successfully deliver at SMTP without encountering any error

Example:

200

​
dropped
integer

Number of emails drop without attempting to deliver either because the email is invalid or email in in existing suppression list

Example:

10

​
hardBounced
integer

Number of emails where we got SMTP hard bounce error code by the recipient mail provider

Example:

10

​
softBounced
integer

Number of emails where we got temporary soft bounce error by the recipent mail provider. Soft bounced emails are retried upto 5 times over 24 hour period before marking them as hardBounced.

Example:

5

​
unsubscribed
integer

Number of email recipients who unsubscribed from receiving further emails

Example:

6

​
spam
integer

Number of email recipients who marked emails as spam

Example:

2

⌘I