Get Link Click Breakdown

GET

api

metrics

links

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/links \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/metrics/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/metrics/links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "period": "30d",
  "totalClicks": 420,
  "totalUniqueClicks": 350,
  "totalLinks": 14,
  "links": [
    {
      "url": "https://example.com/pricing",
      "clicks": 180,
      "uniqueClicks": 120,
      "share": 34.29
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 95,
      "uniqueClicks": 80,
      "share": 22.86
    }
  ]
}

{
  "success": false,
  "error": "'limit' must be an integer from 1 to 50"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Personal API keys inherit your workspace role, and the marketer role cannot use this route (it belongs to workspace settings, integrations, or transactional email). Ask the workspace owner for admin access, or use a company API key issued for this workspace."
}

Returns clicks per link destination across every email in the time range, ranked by unique clicks. Use it to see which pages your emails send people to, without opening each campaign. Each subscriber counts once per link in uniqueClicks, however often they clicked it, so double taps, repeat visits and the same footer link clicked in several emails do not inflate the ranking. clicks still counts every click. Destinations ignore query strings, fragments and trailing slashes, so https://example.com/pricing?utm_campaign=april and https://example.com/pricing/ both count as https://example.com/pricing. Links that differ only by query parameters, such as video or product IDs, are combined too. Test sends are excluded, and detected email-security scanners and link previews are excluded unless you set includeMachineEngagement=true. For one campaign’s links with exact URLs, read clickedLinks from Get Campaign Metrics.

Query Parameters

string

default:"90d"

Sliding window over click times. One of: 1h, 24h, 7d, 30d, 90d. Ignored when start and end are provided.

string

Start of custom time range (ISO 8601). Must be used with end.

string

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

string

Optional structural filter: campaign, sequence, or transactional. Marketer-role personal keys only see links from the campaigns and sequence emails their role can open, and receive 403 for transactional.

string

Optional recipient mailbox provider filter, for example gmail, microsoft, yahoo, or icloud.

number

default:"10"

Number of destinations to return, from 1 to 50.

boolean

default:"false"

Set to true to include detected scanner and link-preview clicks.

Response Fields

string

Applied period, or custom when start and end were provided.

number

Click events across every destination, repeats included, before limit is applied. 0 when nothing was clicked, in which case links is an empty array.

number

Sum of every destination’s uniqueClicks, before limit is applied. A subscriber who clicked two different links counts once for each.

number

Distinct destinations, before limit is applied.

array

Destinations, most unique clicks first, ties broken by total clicks. Each item has url (the destination without query string, fragment or trailing slash), clicks (every recorded click, repeats included), uniqueClicks (subscribers who clicked the destination, each counted once; recipients without a subscriber record count once per email) and share (percentage of totalUniqueClicks, rounded to two decimals).

emailType, mailboxProvider, start, and end are echoed back when you provide them.

curl "https://api.sequenzy.com/api/v1/metrics/links?period=30d&limit=5" \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses

{
  "success": true,
  "period": "30d",
  "totalClicks": 420,
  "totalUniqueClicks": 350,
  "totalLinks": 14,
  "links": [
    {
      "url": "https://example.com/pricing",
      "clicks": 180,
      "uniqueClicks": 120,
      "share": 34.29
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 95,
      "uniqueClicks": 80,
      "share": 22.86
    }
  ]
}

{
  "success": false,
  "error": "'limit' must be an integer from 1 to 50"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Personal API keys inherit your workspace role, and the marketer role cannot use this route (it belongs to workspace settings, integrations, or transactional email). Ask the workspace owner for admin access, or use a company API key issued for this workspace."
}

Get Link Click Breakdown

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/links \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/metrics/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/metrics/links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "period": "30d",
  "totalClicks": 420,
  "totalUniqueClicks": 350,
  "totalLinks": 14,
  "links": [
    {
      "url": "https://example.com/pricing",
      "clicks": 180,
      "uniqueClicks": 120,
      "share": 34.29
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 95,
      "uniqueClicks": 80,
      "share": 22.86
    }
  ]
}

{
  "success": false,
  "error": "'limit' must be an integer from 1 to 50"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Personal API keys inherit your workspace role, and the marketer role cannot use this route (it belongs to workspace settings, integrations, or transactional email). Ask the workspace owner for admin access, or use a company API key issued for this workspace."
}

​Query Parameters

​Response Fields

​Responses

Query Parameters

Response Fields

Responses