Analytics

Get link click breakdown

Changed on

Returns clicks per link destination across every email in the time range, ranked by unique clicks, which count each subscriber once per link however often they clicked. Destinations ignore query strings, fragments and trailing slashes, so the same page linked with different UTM tags counts as one link, and links that differ only by query parameters, such as video or product IDs, are combined. Test sends are excluded. Defaults to the last 90 days. For one campaign's links with exact URLs, read clickedLinks from the campaign metrics endpoint.

get/metrics/links

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/metrics/links
  • Auth
    HTTP bearer

Query parameters

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding window over click times. Ignored when start/end are provided.

startstring date-time

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

endstring date-time

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

emailType'campaign' | 'transactional' | 'sequence'

Structural email type filter. Marketer-role personal keys see links from the campaigns and sequence emails their role can open, and cannot request transactional.

mailboxProviderstring

Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud).

limitinteger

Number of destinations to return.

includeMachineEngagementboolean

Include detected scanner and link-preview clicks.

Response

Success

successboolean required
periodstring required

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

emailType'campaign' | 'transactional' | 'sequence'
mailboxProviderstring

Echoed back when mailboxProvider is provided.

startstring date-time
endstring date-time
totalClicksinteger required

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

totalUniqueClicksinteger required

Sum of every destination's uniqueClicks in scope, before limit is applied.

totalLinksinteger required

Distinct destinations in scope, before limit is applied.

Example response

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

Changes