Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Page tools
On this page
Looking for more inspiration?Visit the

Get Automation Click Tracking Stats by ID

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

operation-overview page anchor

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.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idstring<uuid>
required

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

Query string

query-string page anchor
Property nameTypeRequiredDescription
group_byarray[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
step_idsarray[string<uuid>]
unique

Optional

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

page_sizeinteger

Optional

The number of elements you want returned on each page.

Default: 25Minimum: 1Maximum: 50
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

responses page anchor
200400404
Schema
Property nameTypeRequiredDescriptionChild properties
resultsarray[object]

Optional

total_clicksinteger

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


6
const request = {

7
  url: `/v3/marketing/stats/automations/${id}/links`,

8
  method: "GET",

9
};

10


11
client

12
  .request(request)

13
  .then(([response, body]) => {

14
    console.log(response.statusCode);

15
    console.log(response.body);

16
  })

17
  .catch((error) => {

18
    console.error(error);

19
  });