As a Marketing Campaigns customer, you have access to rich statistics about your Single Sends and Automations. The Marketing Campaigns Statistics API allows you to retrieve these statistics programmatically. for detailed information about the statistics available, see the Marketing Campaigns Stats Overview.
These endpoints provide stats for Marketing Campaigns only. For stats related to event tracking, please see the Stats API.
This endpoint allows you to retrieve stats for a single Automation using its ID.
Multiple Automation IDs can be retrieved using the "Get All Automation Stats" endpoint. Once you have an ID, this endpoint will return detailed stats for the single automation specified.
You may constrain the stats returned using the start_date and end_date query string parameters. You can also use the group_by and aggregated_by query string parameters to further refine the stats returned.
Bearer <<YOUR_API_KEY_HERE>>The ID of the Automation for which you want to retrieve statistics.
Optional
Automations can have multiple steps. Including step_id as a group_by metric allows further granularity of stats.
step_idOptional
Comma-separated list of step_ids that you want the link stats for.
Optional
Dictates how the stats are time-sliced. Currently, "total" and "day" are supported.
totalPossible values: daytotalOptional
Format: YYYY-MM-DD. If this parameter is included, the stats' start date is included in the search.
2021-01-01Optional
Format: YYYY-MM-DD.If this parameter is included, the stats' end date is included in the search.
2021-12-31Optional
IANA Area/Region string representing the timezone in which the stats are to be presented, e.g., "America/Chicago".
UTCOptional
The number of elements you want returned on each page.
1Maximum: 50Default: 25Optional
The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const id = "ZGkrHSypTsudrGkmdpJJ";5const queryParams = {6start_date: "2021-01-01",7end_date: "2021-12-31",8timezone: "UTC",9page_size: 25,10};1112const request = {13url: `/v3/marketing/stats/automations/${id}`,14method: "GET",15qs: queryParams,16};1718client19.request(request)20.then(([response, body]) => {21console.log(response.statusCode);22console.log(response.body);23})24.catch((error) => {25console.error(error);26});