provider Marketing Campaigns Stats GET /marketing/stats/automations/{id}/links
@utdk/sendgrid /marketing/stats/automations/{id}/links
Get Automation Click Tracking Stats by ID
**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. Responses are paginated. You can limit the number of responses returned per batch using the `page_size` query string parameter. The default is 50, but you specify a value between 1 and 100. You can retrieve a specific page of responses with the `page_token` query string parameter.
id path required
The ID of the Automation you want to get click tracking stats for.
string
group_by query
Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.
array
step_ids query
Comma-separated list of `step_ids` that you want the link stats for.
array
page_size query
The number of elements you want returned on each page.
integer
page_token query
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.
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getAutomationLinkStat
GET/marketing/stats/automations/{id}/links
**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. Responses are paginated. You can limit the number of responses returned per batch using the `page_size` query string parameter. The default is 50, but you specify a value between 1 and 100. You can retrieve a specific page of responses with the `page_token` query string parameter.

Parameters

required

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

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

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

The number of elements you want returned on each page.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getAutomationLinkStat({
  "page_size": 50
})