Menu

Stats

Tracking your emails is an important part of being a good sender and learning about how your users interact with your email. This includes everything from basics of clicks and opens to looking at which browsers and mailbox providers your customers use.

We have broken up statistics in specific ways so that you can get at-a-glance data, as well as allowing you to get into the details of how your email is being used.

Category statistics are available for the previous thirteen months only.

Retrieve email statistics by mailbox provider.

Retrieve email statistics by mailbox provider.

GET /mailbox_providers/stats

This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Query String

mailbox_providers
string

The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times.

default: None
limit
integer

The number of results to return.

default: None
offset
integer

The point in the list to begin retrieving results.

default: None
aggregated_by
string

How to group the statistics. Must be either "day", "week", or "month".

default: None
start_date
string

The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.

default: None
required
end_date
string

The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

default: None

Responses

array[object]
date
string

The date that the statistics were gathered.

stats
array[object]

The list of statistics.

type
string

The type of segmentation.

name
string

The name of the specific segmentation.

metrics
object

The individual events and their stats.

blocks
integer

The number of emails that were not allowed to be delivered by ISPs.

bounces
integer

The number of emails that bounced instead of being delivered.

deferred
integer

The number of emails that temporarily could not be delivered.

delivered
integer

The number of emails SendGrid was able to confirm were actually delivered to a recipient.

drops
integer

The number of emails that were not delivered due to the recipient email address being on a suppression list.

requests
integer

The number of emails that were requested to be delivered.

processed
integer

Requests from your website, application, or mail client via SMTP Relay or the Web API that SendGrid processed.

spam_reports
integer

The number of recipients who marked your email as spam.

clicks
integer

The number of links that were clicked in your emails.

unique_clicks
integer

The number of unique recipients who clicked links in your emails.

opens
integer

The total number of times your emails were opened by recipients.

unique_opens
integer

The number of unique recipients who opened your emails.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more