Skip to content
Tallyraydocs

Your workspace's settings: its reports' zone and currency, its attribution window and models, what its campaigns do with bots

GET
/v1/buyer/settings
curl --request GET \
  --url https://example.com/v1/buyer/settings \
  --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”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
attribution
required
object
cross_device
required
boolean
half_life_hours
required
integer format: int64
journeys
required
boolean
lookback_minutes
required
integer format: int64
model
required
string | null
Allowed values: last_click first_click linear time_decay position_based
position_first_bps
required
integer format: int32
position_last_bps
required
integer format: int32
attribution_days
required
integer format: int32
bot_action
required
string | null
Allowed values: flag block
created_at
required
string format: date-time
currency
required
string
sequence
required
integer format: int64
time_zone
required
string
updated_at
required
string format: date-time
updated_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
workspace_id
required
integer format: int64

Example 

{
  "attribution": {
    "model": "last_click"
  },
  "bot_action": "flag",
  "updated_by": {
    "kind": "user"
  }
}

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"
  }
}