Tracking your emails is an important part of being a good sender and learning about how your users interact with your email. This includes everything from basics of clicks and opens to looking at which browsers and mailbox providers your customers use.
We have broken up statistics in specific ways so that you can get at-a-glance data, as well as allowing you to get into the details of how your email is being used.
Category statistics are available for the previous thirteen months only.
This endpoint allows you to retrieve your email statistics segmented by a specific client type.
We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.
Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.
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.
Specifies the type of client to retrieve stats for. Must be either "phone", "tablet", "webmail", or "desktop".
phonetabletwebmaildesktopThe 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.
Optional
How to group the statistics. Must be either "day", "week", or "month".
dayweekmonthArray of:
The date that the statistics were gathered.
The list of statistics.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const client_type = "phone";5const queryParams = {6start_date: "2010-01-22",7};89const request = {10url: `/v3/clients/${client_type}/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});