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 client type.

Retrieve email statistics by client type.

GET /clients/stats

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
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Query String

start_date
string

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

required
end_date
string

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

aggregated_by
string

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

Allowed Values: day, week, month

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.

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.