Sign inGet Started

List a broadcast's clicked links

GET
/v1/email/broadcasts/{broadcast_id}/clicked-links
const links = await bird.broadcasts.listClickedLinks("eb_01krdgeqcxet5s7t44vh8rt9mg");
for (const link of links.data) console.log(link.url, link.click_count, link.recipient_count);
Réponse200
{
  "data": [
    {
      "url": "https://acme.com/whats-new/faster-exports",
      "name": "Faster exports, docs",
      "click_count": 431,
      "recipient_count": 388
    }
  ],
  "total": 57
}

Returns the destination URLs a broadcast's recipients clicked, grouped by URL and sorted by click count. Each entry carries an exact click count and distinct-recipient count over every click event the broadcast has, plus the link's name: the name used by the most clicks that named it, or null if no click through that URL ever carried one. data is capped at the 100 most-clicked URLs; total carries the actual number of distinct URLs clicked, so a capped response is never mistaken for a complete one.

Paramètres

broadcast_idstring

ID of the broadcast whose clicked links to read.

Contenu de la réponse

data
array of object
obligatoire

The broadcast's clicked URLs, most-clicked first, capped at 100 rows.

Afficher les attributs enfants
total
integer
obligatoire

Total number of distinct URLs the broadcast's recipients clicked, regardless of the cap on data. When it exceeds the number of rows returned, the list was capped at the 100 most-clicked URLs.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.