Retrieve stats by a specific client type.

API Overview

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

GET/v3/clients/{client_type}/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 a specific 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.

Available Client Types

phone
tablet
webmail
desktop

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

Authentication

API Key

Headers

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.

Path parameters

Property nameTypeRequiredDescription

client_typeenum<string>

required

Specifies the type of client to retrieve stats for. Must be either "phone", "tablet", "webmail", or "desktop".

Possible values:

phonetabletwebmaildesktop

Query string

Property nameTypeRequiredDescription

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.

aggregated_byenum<string>

Optional

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

Possible values:

dayweekmonth

Responses

200

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

datestring

Optional

The date that the statistics were gathered.

statsarray[object]

Optional

The list of statistics.

Show stats properties

Retrieve stats by a specific client type.

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const client_type = "phone";
5const queryParams = { start_date: "2009-07-06" };
6
7const request = {
8  url: `/v3/clients/${client_type}/stats`,
9  method: "GET",
10  qs: queryParams,
11};
12
13client
14  .request(request)
15  .then(([response, body]) => {
16    console.log(response.statusCode);
17    console.log(response.body);
18  })
19  .catch((error) => {
20    console.error(error);
21  });