Skip to content
Tallyraydocs

A connection, with which of its sealed fields are set

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

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
connected_at
required
string | null format: date-time
created_at
required
string format: date-time
created_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
effective
required
object
auth
required
string | null
Allowed values: none api_key basic bearer oauth2 hmac login
consent
required
string | null
Allowed values: none eea
cost_models
required
Array<string | null>
Allowed values: from_token cpc cpm cpa revshare api none
costs
required
boolean
events
required
Array<object>
object
kind
required
string | null
Allowed values: lead registration sale deposit subscription rebill custom install reengagement
name
required
string
fields
required
Array<object>
object
help
required
string
label
required
string
name
required
string
pattern
required
string
required
required
boolean
sealed
required
boolean
type
required
string | null
Allowed values: string int bool enum map
values
required
Array<string>
final_url_direct
required
boolean
hosts
required
Array<string>
max_age_seconds
required
integer format: int64
needs
required
Array<string | null>
Allowed values: ip user_agent page_url fbp
network
required
Any of:
object
click_id_param
required
string
default_kind
required
string | null
Allowed values: lead registration sale deposit subscription rebill custom install reengagement
keep_named
required
boolean
method
required
string
offer_params
required
Array<object>
object
name
required
string
value
required
string
params
required
Array<object>
object
field
required
string | null
Allowed values: click_id event status payout currency txid timestamp email phone first_name last_name city zip country external_id coupon campaign placement source_campaign creative
location
required
string | null
Allowed values: query form json
macro
required
string
name
required
string
signature
required
string | null
Allowed values: none answick_url
statuses
required
Array<object>
object
name
required
string
status
required
string | null
Allowed values: approved pending declined chargeback
txid_from
required
Array<string>
without_click
required
Array<string | null>
Allowed values: click_id event status payout currency txid timestamp email phone first_name last_name city zip country external_id coupon campaign placement source_campaign creative
objects
required
Any of:
object
levels
required
Array<object>
object
key_tokens
required
Array<string>
level
required
string | null
Allowed values: campaign ad_group ad placement
sealed_fields
required
Array<string>
spend
required
boolean
settle_seconds
required
integer format: int64
overridable
required
Array<string>
personal_data
required
boolean
placements
required
boolean
probe
required
boolean
send_on
required
Array<string | null>
Allowed values: approved pending declined chargeback
test_conversion
required
boolean
test_note
required
string
token_cost
required
Any of:
object
currency
required
string
param
required
string
unit
required
string | null
Allowed values: visit thousand_visits
tokens
required
Array<object>
object
auto
required
boolean
field
required
string | null
Allowed values: placement source_campaign creative site keyword custom external_click_id cost impression_id
label
required
string
macro
required
string
param
required
string
slot
required
integer format: int32
user_identifiers
required
Array<string>
values
required
Any of:
object
levels
required
Array<object>
object
bounds
required
Any of:
object
increment
required
Any of:
object
amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
factor_ppm
required
integer | null format: int64
max
required
Any of:
object
amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
factor_ppm
required
integer | null format: int64
min
required
Any of:
object
amount
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
factor_ppm
required
integer | null format: int64
by_country
required
boolean
currency
required
string
inherits
required
string | null
Allowed values: campaign ad_group ad placement
key_tokens
required
Array<string>
kind
required
string | null
Allowed values: bid budget
level
required
string | null
Allowed values: campaign ad_group ad placement
reset
required
boolean
sealed_fields
required
Array<string>
spend
required
boolean
units
required
Array<string | null>
Allowed values: cpc cpm cpv cpa factor daily
settle_seconds
required
integer format: int64
fields
required
object
key
additional properties
Any of:
string
held_from_version
required
integer format: int32
id
required
integer format: int64
kind
required
string | null
Allowed values: traffic_source affiliate_network
name
required
string
objects
required
Array<object>
object
level
required
string | null
Allowed values: campaign ad_group ad placement
message
required
string
missing_fields
required
Array<string>
ready
required
boolean
reason
required
string | null
Allowed values: secret_missing not_connected scopes_missing forbidden connection_paused
override
required
string
retire_after
required
string | null format: date-time
scopes_missing
required
Array<string>
sealed
Array<object>
object
last4
required
string
name
required
string
set
required
boolean
updated_at
required
string | null format: date-time
sequence
required
integer format: int64
status
required
string | null
Allowed values: active auth_failed paused
status_message
required
string
template_id
required
string
template_version
required
integer format: int32
updated_at
required
string format: date-time
values
required
Array<object>
object
kind
required
string | null
Allowed values: bid budget
level
required
string | null
Allowed values: campaign ad_group ad placement
message
required
string
missing_fields
required
Array<string>
ready
required
boolean
reason
required
string | null
Allowed values: secret_missing not_connected scopes_missing forbidden connection_paused
workspace_id
required
integer format: int64

Example 

{
  "created_by": {
    "kind": "user"
  },
  "effective": {
    "auth": "none",
    "consent": "none",
    "cost_models": [
      "from_token"
    ],
    "events": [
      {
        "kind": "lead"
      }
    ],
    "fields": [
      {
        "type": "string"
      }
    ],
    "needs": [
      "ip"
    ],
    "network": {
      "default_kind": "lead",
      "params": [
        {
          "field": "click_id",
          "location": "query"
        }
      ],
      "signature": "none",
      "statuses": [
        {
          "status": "approved"
        }
      ],
      "without_click": [
        "click_id"
      ]
    },
    "objects": {
      "levels": [
        {
          "level": "campaign"
        }
      ]
    },
    "send_on": [
      "approved"
    ],
    "token_cost": {
      "unit": "visit"
    },
    "tokens": [
      {
        "field": "placement"
      }
    ],
    "values": {
      "levels": [
        {
          "inherits": "campaign",
          "kind": "bid",
          "level": "campaign",
          "units": [
            "cpc"
          ]
        }
      ]
    }
  },
  "kind": "traffic_source",
  "objects": [
    {
      "level": "campaign",
      "reason": "secret_missing"
    }
  ],
  "status": "active",
  "values": [
    {
      "kind": "bid",
      "level": "campaign",
      "reason": "secret_missing"
    }
  ]
}

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