Skip to contentSkip to navigationSkip to topbar
On this page

Get Automation Click Tracking 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/automations/{id}/links

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

This endpoint lets you retrieve click-tracking stats for a single Automation.

The stats returned list the URLs embedded in your Automation and the number of clicks each one received.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstring<uuid>
required

The ID of the Automation you want to get click tracking stats for.

Property nameTypeRequiredDescription
groupByarray[enum<string>]

Optional

Automations can have multiple steps. Including step_id as a group_by metric allows further granularity of stats.

Possible values:
step_id

stepIdsarray[string<uuid>]
unique

Optional

Comma-separated list of step_ids that you want the link stats for.


pageSizeinteger

Optional

The number of elements you want returned on each page.

Default: 25Minimum: 1Maximum: 50

pageTokenstring

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.

200400404
Schema
Property nameTypeRequiredDescriptionChild properties
resultsarray[object]

Optional


totalClicksinteger

Optional


Metadatalink tracking metadata

Optional

Get Automation Click Tracking Stats by IDLink to code sample: Get Automation Click Tracking Stats by ID
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";
5
const queryParams = { page_size: 25 };
6
7
const request = {
8
url: `/v3/marketing/stats/automations/${id}/links`,
9
method: "GET",
10
qs: queryParams,
11
};
12
13
client
14
.request(request)
15
.then(([response, body]) => {
16
console.log(response.statusCode);
17
console.log(response.body);
18
})
19
.catch((error) => {
20
console.error(error);
21
});