email-broadcasts

List a broadcast's clicked links

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.

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

Path parameters

broadcast_idstring required
Example:eb_01krdgeqcxet5s7t44vh8rt9mg

ID of the broadcast whose clicked links to read.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The broadcast's clicked links, grouped by URL.

totalinteger 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.

Example response

{
  "data": [
    {
      "url": "https://acme.com/whats-new/faster-exports",
      "name": "Faster exports, docs",
      "click_count": 431,
      "recipient_count": 388
    }
  ],
  "total": 57
}

Changes

No recorded changes to this operation across all 2 revisions of this API.