Menu

Expand
Rate this page:

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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Query String

sort_by_direction
string

The direction you want to sort.

default: desc
start_date
string

The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.

default: None
required
end_date
string

The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

default: None
limit
integer

Limits the number of results returned per page.

default: 5
offset
integer

The point in the list to begin retrieving results from.

default: 0
aggregated_by
string

How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.

default: None
sort_by_metric
string

The metric that you want to sort by. Must be a single metric.

default: delivered

Responses

object
date
string

The date the statistics were gathered.

required
stats
array[object]
metrics
object
blocks
integer

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

required
bounce_drops
integer

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

required
bounces
integer

The number of emails that bounced instead of being delivered.

required
clicks
integer

The number of links that were clicked.

required
deferred
integer

The number of emails that temporarily could not be delivered.

required
delivered
integer

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

required
invalid_emails
integer

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

required
opens
integer

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

required
processed
integer

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

required
requests
integer

The number of emails that were requested to be delivered.

required
spam_report_drops
integer

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

required
spam_reports
integer

The number of recipients who marked your email as spam.

required
unique_clicks
integer

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

required
unique_opens
integer

The number of unique recipients who opened your emails.

required
unsubscribe_drops
integer

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

required
unsubscribes
integer

The number of recipients who unsubscribed from your emails.

required
name
string

The name of the category.

type
string

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"
    }
  ]
}
        
        
        
        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!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              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