API · Broadcasts

List Clicked Links

List broadcast links ranked by total clicks, highest first (requires full access). Unique clicks count distinct recipient messages, and completed reports are kept for 30 days.

GET/broadcasts/{id}/clicked-linksFull access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Resource identifier for id.
`limit` query · optional	`integer` 1–100 Default: 20	Number of results to return. See Pagination.
`after` query · optional	`string`	Resource ID for the next page. Cannot be combined with before. See Pagination.
`before` query · optional	`string`	Resource ID for the previous page. Cannot be combined with after. See Pagination.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/broadcasts/YOUR_id/clicked-links" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "YOUR_ID",
      "url": "example",
      "clicks": 1,
      "unique_clicks": 1
    }
  ]
}

Behavior and errors

Follow ID cursors to read the clicked-link report. See broadcasts for tracking prerequisites.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.