Categories
Elements that can be shared among more than one endpoint definition.
Retrieve sums of email stats for each category
Effective February 1, 2022, Twilio SendGrid will limit the number of stored category statistics available per user. Accounts on a paid plan will be allowed 1,000 categories daily. Accounts on a free plan will be allowed 100 categories daily. For more information about this change, see the Limitations section of our "Working with Categories" page.
Category statistics are available for the previous thirteen months only.
GET /v3/categories/stats/sums
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.
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
The on-behalf-of
header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>
). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>
). See On Behalf Of for more information.
Query String
The metric that you want to sort by. Must be a single metric.
default: deliveredThe 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.
default: 5The point in the list to begin retrieving results.
default: 0How to group the statistics. Must be either "day", "week", or "month".
default: NoneResponses
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.