---
title: "List a broadcast's clicked links"
method: GET
path: "/v1/email/broadcasts/{broadcast_id}/clicked-links"
tags: ["email-broadcasts"]
---

# List a broadcast's clicked links

`GET /v1/email/broadcasts/{broadcast_id}/clicked-links`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/broadcasts/{broadcast_id}/clicked-links`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

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.

## Path parameters

- `broadcast_id` string, required

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The broadcast's clicked links, grouped by URL.

- EmailBroadcastClickedLinkList
  - `data` EmailBroadcastClickedLink[], required: The broadcast's clicked URLs, most-clicked first, capped at 100 rows.
    - `url` string, required: The clicked URL.
    - `name` string, nullable, required: What the link said, resolved by the name used by the most clicks that carried one. Null when no click through this URL ever carried a name.
    - `click_count` integer, required: Total clicks through this URL, including clicks that carried no link name.
    - `recipient_count` integer, required: Number of distinct recipients who clicked this URL at least once.
  - `total` integer, required: 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.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)