Skip to content
Tallyraydocs

The click log: a range of at most 31 days (the last day by default) within what the workspace keeps, filtered on its visits' dimensions and its own (offer, network, lander, step_lander), or one click (click_id)

GET
/v1/buyer/clicks
curl --request GET \
  --url 'https://example.com/v1/buyer/clicks?sort=clicked_at' \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the stats:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

from
string
to
string
bot
string
click_id
string
filter
string
exclude
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
campaign
required
object
id
required
integer format: int64
name
string
capped_offer
required
Any of:
object
id
required
integer format: int64
name
string
click_id
required
string
clicked_at
required
string format: date-time
consent
required
object
ad_personalization
required
string | null
Allowed values: granted denied
ad_user_data
required
string | null
Allowed values: granted denied
eea
required
boolean
engagement
required
Any of:
object
interacted
required
boolean
page_ms
required
integer format: int64
trusted
required
boolean
webdriver
required
boolean
lander
required
Any of:
object
id
required
integer format: int64
name
string
network
required
Any of:
object
id
required
integer format: int64
name
string
offer
required
Any of:
object
id
required
integer format: int64
name
string
offer_position
required
integer format: int32
source
required
string | null
Allowed values: visit_token cookie direct
step_landers
required
Array<object>
object
id
required
integer format: int64
name
string
visit
required
object
asn
required
integer format: int64
bot
required
boolean
bot_reason
required
string
bot_score
required
integer format: int32
browser
required
string
browser_version
required
string
campaign_id
required
integer format: int64
carrier
required
string
channel
required
string | null
Allowed values: campaign paid email social search referral direct
city
required
string
connection_id
required
integer format: int64
connection_type
required
string
consent
required
object
ad_personalization
required
string | null
Allowed values: granted denied
ad_user_data
required
string | null
Allowed values: granted denied
eea
required
boolean
country
required
string
creative
required
string
device_brand
required
string
device_type
required
string
external_click_id
required
string
external_click_param
required
string
flow_id
required
integer format: int64
isp
required
string
keyword
required
string
lander_id
required
integer format: int64
language
required
string
os
required
string
os_version
required
string
path_id
required
integer format: int64
placement
required
string
referrer_domain
required
string
region
required
string
rule_id
required
integer format: int64
site
required
string
source_campaign
required
string
tokens
required
Array<object>
object
param
required
string
slot
required
integer format: int32
truncated
required
boolean
value
required
string
visit_id
required
string
visited_at
required
string format: date-time
workspace_id
required
integer format: int64
visit_found
required
boolean
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "consent": {
        "ad_personalization": "granted",
        "ad_user_data": "granted"
      },
      "source": "visit_token",
      "visit": {
        "channel": "campaign",
        "consent": {
          "ad_personalization": "granted",
          "ad_user_data": "granted"
        }
      }
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}