Menu

Expand
Rate this page:

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 global email statistics

GET /v3/stats

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve all of your global email statistics between a given date range.

Parent accounts can see either aggregated stats for the parent account or aggregated stats for a subuser specified in the on-behalf-of header. Subuser accounts will see only their own stats.

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

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 the stats were gathered.

stats
array[object]

The individual email activity stats.

metrics
object

The individual events and their stats.

blocks
integer

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

bounce_drops
integer

The number of emails that were dropped because of a bounce.

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.

invalid_emails
integer

The number of recipients who had malformed email addresses or whose mail provider reported the address as invalid.

processed
integer

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

requests
integer

The number of emails that were requested to be delivered.

spam_report_drops
integer

The number of emails that were dropped due to a recipient previously marking your emails as spam.

spam_reports
integer

The number of recipients who marked your email as spam.

unsubscribe_drops
integer

The number of emails dropped due to a recipient unsubscribing from your emails.

unsubscribes
integer

The number of recipients who unsubscribed from your emails.

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. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              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