Menu

Categories

Elements that can be shared among more than one endpoint definition.

Retrieve Email Statistics for Categories

Retrieve Email Statistics for Categories

GET /categories/stats

This endpoint allows you to retrieve all of your email statistics for each of your categories.

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Query String

start_date
string

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

required
end_date
string

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

categories
string

The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.

required
limit
integer

The number of results to return.

offset
integer

The point in the list to begin retrieving results.

aggregated_by
string

How to group the statistics. Must be either "day", "week", or "month".

Allowed Values: day, week, month

Responses

array[object]
date
string

The date the statistics were gathered.

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.

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.