Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Page tools
On this page
Looking for more inspiration?Visit the

Retrieve email statistics by mailbox provider.

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.

Operation overview

operation-overview page anchor

GET/v3/mailbox_providers/stats

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstring

Optional

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.

Query string

query-string page anchor
Property nameTypeRequiredDescription
mailbox_providersstring

Optional

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

limitinteger

Optional

The number of results to return.

offsetinteger

Optional

The point in the list to begin retrieving results.

aggregated_byenum<string>

Optional

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

Possible values:
dayweekmonth
start_datestring
required

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

end_datestring

Optional

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

Responses

responses page anchor
200
SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties
datestring

Optional

The date that the statistics were gathered.

statsarray[object]

Optional

The list of statistics.

Retrieve email statistics by mailbox provider.Link to code sample: Retrieve email statistics by mailbox provider.
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const queryParams = { start_date: "2009-07-06" };

5


6
const request = {

7
  url: `/v3/mailbox_providers/stats`,

8
  method: "GET",

9
  qs: queryParams,

10
};

11


12
client

13
  .request(request)

14
  .then(([response, body]) => {

15
    console.log(response.statusCode);

16
    console.log(response.body);

17
  })

18
  .catch((error) => {

19
    console.error(error);

20
  });