Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve global email statistics



API Overview

api-overview page anchor

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.

(information)

Info

Category statistics are available for the previous thirteen months only.


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

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

limitinteger

The number of results to return.


offsetinteger

The point in the list to begin retrieving results.


aggregated_byenum<string>

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

Possible values:
dayweekmonth

start_datestringrequired

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


end_datestring

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

200
SchemaExample

Array of:

datestring

The date the stats were gathered.


statsarray[object]

The individual email activity stats.

Retrieve global email statistics

retrieve-global-email-statistics page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"start_date": "2010-01-22"
_21
};
_21
_21
const request = {
_21
url: `/v3/stats`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});


Rate this page: