Menu

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 monthly stats for all subusers

Retrieve monthly stats for all subusers

GET /subusers/stats/monthly

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Query String

date
string

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

default: None
required
subuser
string

A substring search of your subusers.

default: None
sort_by_metric
string

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_direction
string

The direction you want to sort.

default: desc
limit
integer

The number of results to return.

default: None
offset
integer

The point in the list to begin retrieving results.

default: None

Responses

object
date
string

The date the statistics were gathered.

stats
array[object]

The list of statistics.

first_name
string

The first name of the subuser.

last_name
string

The last name of the subuser.

metrics
object
blocks
integer

The number of emails that were not allowed to be delivered by ISPs.

bounce_drops
integer

The number of emails that were dropped because of a bounce.

bounces
integer

The number of emails that bounced instead of being delivered.

clicks
integer

The number of links that were clicked in your emails.

deferred
integer

The number of emails that temporarily could not be delivered.

delivered
integer

The number of emails SendGrid was able to confirm were actually delivered to a recipient.

invalid_emails
integer

The number of recipients who had malformed email addresses or whose mail provider reported the address as invalid.

opens
integer

The total number of times your emails were opened by recipients.

processed
integer

Requests from your website, application, or mail client via SMTP Relay or the API that SendGrid processed.

requests
integer

The number of emails that were requested to be delivered.

spam_report_drops
integer

The number of emails that were dropped due to a recipient previously marking your emails as spam.

spam_reports
integer

The number of recipients who marked your email as spam.

unique_clicks
integer

The number of unique recipients who clicked links in your emails.

unique_opens
integer

The number of unique recipients who opened your emails.

unsubscribe_drops
integer

The number of emails dropped due to a recipient unsubscribing from your emails.

unsubscribes
integer

The number of recipients who unsubscribed from your emails.

name
string

The username of the subuser.

type
string

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"
    }
  ]
}
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more