Skip to content
Tallyraydocs

Conversions received in a range of at most 93 days (the last 30 by default)

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

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write 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
campaign_id
string
offer_id
string
network_id
string
connection_id
string
event_type
string
status
string
click_id
string
visit_id
string
txid
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
basis
required
string | null
Allowed values: click coupon campaign
campaign
required
object
id
required
integer format: int64
name
string
click_id
required
string
cost
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
coupon
required
Any of:
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
credit_terms
required
Any of:
object
cross_device
required
boolean
half_life_hours
required
integer format: int64
journey_incomplete
required
boolean
lookback_minutes
required
integer format: int64
position_first_bps
required
integer format: int32
position_last_bps
required
integer format: int32
credits
required
Array<object>
object
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
revenue
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
share_micros
required
integer format: int64
touch
required
integer format: int32
event_kind
required
string | null
Allowed values: lead registration sale deposit subscription rebill custom install reengagement
event_type
required
string
id
required
string
network
required
object
id
required
integer format: int64
name
string
occurred_at
required
string | null format: date-time
offer
required
object
id
required
integer format: int64
name
string
origin
required
string | null
Allowed values: postback import
postback_id
required
string
received_at
required
string | null format: date-time
revenue
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
sequence
required
integer format: int64
signed
required
boolean
status
required
string | null
Allowed values: approved pending declined chargeback
touches
required
Array<object>
object
campaign
required
object
id
required
integer format: int64
name
string
click_id
required
string
clicked_at
required
string | null format: date-time
connection
required
object
id
required
integer format: int64
name
string
creative
required
string
other_device
required
boolean
placement
required
string
source_campaign
required
string
txid
required
string
updated_at
required
string format: date-time
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
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "basis": "click",
      "credits": [
        {
          "model": "last_click"
        }
      ],
      "event_kind": "lead",
      "origin": "postback",
      "status": "approved",
      "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"
  }
}