Retrieve Email Statistics for Categories
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
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.
Info
Category statistics are available for the previous thirteen months only.
GET/v3/categories/stats
Base url: https://api.sendgrid.com (for global users and subusers)
Base url: https://api.eu.sendgrid.com (for EU regional subusers)
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.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD
Optional
The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.
Optional
How to group the statistics. Must be either "day", "week", or "month".
dayweekmonthArray of:
Optional
The date the statistics were gathered.
Optional
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const queryParams = {5categories: "categories",6start_date: "2009-07-06",7};89const request = {10url: `/v3/categories/stats`,11method: "GET",12qs: queryParams,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});
