Retrieve monthly stats 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/monthly

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 monthly email statistics for all subusers over the given date range.

When using the sort_by_metric to sort your stats by a specific metric, you can not sort by the following metrics: bounce_drops, deferred, invalid_emails, processed, spam_report_drops, spam_reports, or unsubscribe_drops.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

datestring

required

The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD

subuserstring

Optional

A substring search of your subusers.

sort_by_metricenum<string>

Optional

The metric that you want to sort by. Metrics that you can sort by are: blocks, bounces, clicks, delivered, opens, requests, unique_clicks, unique_opens, and unsubscribes.'

Default: deliveredPossible values:

blocksbouncesclicksdeliveredopensrequestsunique_clicksunique_opensunsubscribes

sort_by_directionenum<string>

Optional

The direction you want to sort.

Default: descPossible values:

descasc

limitinteger

Optional

Optional field to limit the number of results returned.

Default: 5

offsetinteger

Optional

Optional beginning point in the list to retrieve from.

Default: 0

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

datestring

Optional

The date the statistics were gathered.

statsarray[object]

Optional

The list of statistics.

Show stats properties

Retrieve monthly stats for all subusers

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