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.
(information)
Note
These endpoints provide stats for Marketing Campaigns only. For stats related to event tracking, please see the Stats API.
Operation overview
GET/v3/marketing/stats/singlesends/{id}
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve stats for an individual Single Send using a Single Send ID.
Multiple Single Send IDs can be retrieved using the "Get All Single Sends Stats" endpoint. Once you have an ID, this endpoint will return detailed stats for the Single Send 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.
Operation details
Authentication
Headers
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Path parameters
Property nameTypeRequiredDescription
idstringrequired
The ID of Single Send for which you want to retrieve stats.
Query string
Property nameTypeRequiredDescription
aggregated_byenum<string>Optional
Dictates how the stats are time-sliced. Currently, "total" and "day" are supported.
Default: totalPossible values:
daytotal
start_datestring<date>Optional
Format: YYYY-MM-DD. If this parameter is included, the stats' start date is included in the search.
Default: 2021-01-01
end_datestring<date>Optional
Format: YYYY-MM-DD.If this parameter is included, the stats' end date is included in the search.
Default: 2021-12-31
timezonestringOptional
IANA Area/Region string representing the timezone in which the stats are to be presented, e.g., "America/Chicago".
Default: UTC
page_sizeintegerOptional
The number of elements you want returned on each page.
Minimum: 1Maximum: 50Default: 25
page_tokenstringOptional
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.
group_byarray[enum<string>]Optional
A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields.
This is the ID of the Single Send you require stats for.
ab_variationstring<uuid>
This is the A/B variation of the Single Send stat returned. If the group_by parameter doesn't include ab_variation in the request, then the value is "all".
Default: a14dcc63-d651-4c57-9826-4a3705f5c78d
ab_phaseenum<string>
This is the A/B phase of the Single Send stat returned. If the group_by parameter doesn't include ab_phase in the request, then the value is "all".
Default: allPossible values:
sendtestall
aggregationstring
This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be "total" or the date (in YYYY-MM-DD format) the stats are for.