On this page

Retrieve the totals for each email statistic metric for all subusers.

API Overview

Subuser statistics enable you to view specific segments of your statistics, as compared to the general overview of all email activity on your account. SendGrid tracks your subusers' emails sent, bounces, and spam reports. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.

For more information, see our Subusers documentation. You can also access Subuser Statistics in the SendGrid console.

Operation overview

GET/v3/subusers/stats/sums

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 the total sums of each email statistic metric for all subusers over the given date range.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

sort_by_directionenum<string>Optional

The direction you want to sort.

Default: descPossible values:

descasc

start_datestringrequired

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

end_datestringOptional

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

limitintegerOptional

Limits the number of results returned per page.

Default: 5

offsetintegerOptional

The point in the list to begin retrieving results from.

Default: 0

aggregated_bystringOptional

How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.

sort_by_metricstringOptional

The metric that you want to sort by. Must be a single metric.

Default: delivered

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

datestring

The date the statistics were gathered.

statsarray[object]

Show child properties for stats

Retrieve the totals for each email statistic metric for all subusers.

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  start_date: "2010-01-22",
6  limit: 5,
7  sort_by_metric: "delivered",
8};
9
10const request = {
11  url: `/v3/subusers/stats/sums`,
12  method: "GET",
13  qs: queryParams,
14};
15
16client
17  .request(request)
18  .then(([response, body]) => {
19    console.log(response.statusCode);
20    console.log(response.body);
21  })
22  .catch((error) => {
23    console.error(error);
24  });