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 monthly email statistics for a single subuser
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
- API Key
Headers
Path Parameters
Query String
The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD
default: NoneThe 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.'
The direction you want to sort.
default: descOptional field to limit the number of results returned.
default: 5Optional beginning point in the list to retrieve from.
default: 0Responses
The date the statistics were gathered.
The list of statistics.
The first name of the subuser.
The last name of the subuser.
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 in your emails.
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 username of the subuser.
The type of account.
{
"date": "2016-02-01",
"stats": [
{
"first_name": "John",
"last_name": "Doe",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 5,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 10,
"processed": 10,
"requests": 10,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "user1",
"type": "subuser"
}
]
}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.
