On this page

Get All Single Sends Stats

API Overview

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

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to retrieve stats for all your Single Sends.

By default, all of your Single Sends will be returned, but you can specify a selection by passing in a comma-separated list of Single Send IDs as the value of the query string parameter singlesend_ids.

Responses are paginated. You can limit the number of responses returned per batch using the page_size query string parameter. The default is 25, but you specify a value between 1 and 50.

You can retrieve a specific page of responses with the page_token query string parameter.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

singlesend_idsarray[string]

Optional

This endpoint returns all Single Send IDs if no IDs are included in singlesend_ids.

page_sizeinteger

Optional

The number of elements you want returned on each page.

Minimum: 1Maximum: 50Default: 25

page_tokenstring

Optional

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.

Responses

200400

Schema

Property nameTypeRequiredDescriptionChild properties

resultsarray[object]

Show child properties for results

_metadataobject

Show child properties for _metadata

Get All Single Sends Stats

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  page_size: 25,
6};
7
8const request = {
9  url: `/v3/marketing/stats/singlesends`,
10  method: "GET",
11  qs: queryParams,
12};
13
14client
15  .request(request)
16  .then(([response, body]) => {
17    console.log(response.statusCode);
18    console.log(response.body);
19  })
20  .catch((error) => {
21    console.error(error);
22  });