Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve Email Statistics for Categories



API Overview

api-overview page anchor

Categories can help organize your email analytics by enabling you to group emails by type. Just as you can view the statistics on all your email activity, you can go a step further and view the statistics by a particular category.

(warning)

Warning

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.

(information)

Info

Category statistics are available for the previous thirteen months only.


GET/v3/categories/stats

Base url: https://api.sendgrid.com

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

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

start_datestringrequired

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


end_datestring

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


categoriesstringrequired

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


aggregated_byenum<string>

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

Possible values:
dayweekmonth
200
SchemaExample

Array of:

datestring

The date the statistics were gathered.


statsarray[object]

Retrieve Email Statistics for Categories

retrieve-email-statistics-for-categories page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const queryParams = {
_22
"start_date": "2010-01-22",
_22
"categories": "ZGkrHSypTsudrGkmdpJJ"
_22
};
_22
_22
const request = {
_22
url: `/v3/categories/stats`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: