Skip to main content
GET
/
v1
/
clicks
List
curl --request GET \
  --url https://{defaultHost}/v1/clicks \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/clicks"
  },
  "data": [
    {
      "id": "fed8a714-151c-4931-8e82-f4bd5cadff91",
      "object": "click",
      "anonymous_id": "95212018-9f08-4426-a25f-2300f15cc1fb",
      "domain": "carroll.test",
      "converted": false,
      "expires_at": 1770501686,
      "referrer": null,
      "url": "http://carroll.test/alvaro.feeney",
      "affiliation": "76671c59-d5fd-4760-a141-858e587608fc",
      "previous_click": null,
      "created_at": 1767909686,
      "updated_at": 1767909686
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
affiliation_ids[]
string[]

Only return objects that belong to the given affiliations.

​
converted
boolean

Only return objects that have converted or not converted.

​
expired
boolean

Only return objects that have expired or not expired.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
original
boolean

Only return clicks that are the first in an anonymous ID stream or not.

​
page
integer

The page of items you want returned.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.