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

Get Single Send Stats by ID



API Overview

api-overview page anchor

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.


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.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstringrequired

The ID of Single Send for which you want to retrieve stats.

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

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.

Possible values:
ab_variationab_phase
200400404
Schema
Property nameTypeRequiredDescriptionChild properties
resultsarray[object]

_metadataobject

Get Single Send Stats by ID

get-single-send-stats-by-id page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_26
const client = require('@sendgrid/client');
_26
client.setApiKey(process.env.SENDGRID_API_KEY);
_26
_26
const id = "ZGkrHSypTsudrGkmdpJJ";
_26
const queryParams = {
_26
"aggregated_by": "total",
_26
"start_date": "2021-01-01",
_26
"end_date": "2021-12-31",
_26
"timezone": "UTC",
_26
"page_size": 25
_26
};
_26
_26
const request = {
_26
url: `/v3/marketing/stats/singlesends/${id}`,
_26
method: 'GET',
_26
qs: queryParams
_26
}
_26
_26
client.request(request)
_26
.then(([response, body]) => {
_26
console.log(response.statusCode);
_26
console.log(response.body);
_26
})
_26
.catch(error => {
_26
console.error(error);
_26
});


Rate this page: