Subuser Statistics
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.
Retrieve the totals for each email statistic metric for all subusers.
GET /v3/subusers/stats/sums
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.
Authentication
- API Key
Headers
Query String
The direction you want to sort.
default: descThe starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
default: NoneThe end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
default: NoneLimits the number of results returned per page.
default: 5The point in the list to begin retrieving results from.
default: 0How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.
default: NoneThe metric that you want to sort by. Must be a single metric.
default: deliveredResponses
The date the statistics were gathered.
The number of emails that were not allowed to be delivered by ISPs.
The number of emails that were dropped because of a bounce.
The number of emails that bounced instead of being delivered.
The number of links that were clicked.
The number of emails that temporarily could not be delivered.
The number of emails SendGrid was able to confirm were actually delivered to a recipient.
The number of recipients who had malformed email addresses or whose mail provider reported the address as invalid.
The total number of times your emails were opened by recipients.
Requests from your website, application, or mail client via SMTP Relay or the API that SendGrid processed.
The number of emails that were requested to be delivered.
The number of emails that were dropped due to a recipient previously marking your emails as spam.
The number of recipients who marked your email as spam.
The number of unique recipients who clicked links in your emails.
The number of unique recipients who opened your emails.
The number of emails dropped due to a recipient unsubscribing from your emails.
The number of recipients who unsubscribed from your emails.
The name of the category.
How you are segmenting your statistics.
{
"date": "2015-01-01",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "cat1",
"type": "category"
},
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "cat2",
"type": "category"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
