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 email statistics by client type.

GET /v3/clients/stats

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

This endpoint allows you to retrieve your email statistics segmented by client type.

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

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

Query String

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
aggregated_by
string

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

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.

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.

Loading Code Sample...
        
        

        Retrieve email statistics by client type.

        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.

        Loading Code Sample...
              
              
              

              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!

              thanks-feedback-gif