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

Retrieve the monthly email statistics for a single subuser



API Overview

api-overview page anchor

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(link takes you to an external page).


GET/v3/subusers/{subuser_name}/stats/monthly

Base url: https://api.sendgrid.com

This endpoint allows you to retrive the monthly email statistics for a specific subuser.

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.


Authentication

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

The username of the Subuser.

datestringrequired

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


sort_by_metricstring

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: delivered

sort_by_directionenum<string>

The direction you want to sort.

Default: descPossible values:
descasc

limitinteger

Optional field to limit the number of results returned.

Default: 5

offsetinteger

Optional beginning point in the list to retrieve from.

Default: 0
200
SchemaExample
datestring

The date the statistics were gathered.


statsarray[object]

The list of statistics.

Retrieve the monthly email statistics for a single subuser

retrieve-the-monthly-email-statistics-for-a-single-subuser page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const subuser_name = "Miss Christine Morgan";
_25
const queryParams = {
_25
"date": "2010-01-22",
_25
"sort_by_metric": "delivered",
_25
"sort_by_direction": "desc",
_25
"limit": 5
_25
};
_25
_25
const request = {
_25
url: `/v3/subusers/${subuser_name}/stats/monthly`,
_25
method: 'GET',
_25
qs: queryParams
_25
}
_25
_25
client.request(request)
_25
.then(([response, body]) => {
_25
console.log(response.statusCode);
_25
console.log(response.body);
_25
})
_25
.catch(error => {
_25
console.error(error);
_25
});


Rate this page: