Skip to content
Tallyraydocs

Up to 100 of a connection's source objects at one level by key, as connectors last read them, with the source's own spend for each over a range of at most 31 days; refresh reads them from the source now, a buyer's, 10 a minute for each connection

POST
/v1/buyer/source-objects/read
curl --request POST \
  --url https://example.com/v1/buyer/source-objects/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "connection_id": 1, "keys": [ { "country": "example", "source_campaign": "example", "values": [ "example" ] } ], "level": "campaign", "refresh": true, "spend_from": "2026-04-15T12:00:00Z", "spend_to": "2026-04-15T12:00:00Z" }'

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”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
connection_id
required
integer format: int64
keys
required
Array<object>
object
country
string
source_campaign
string
values
required
Array<string>
level
required
string
Allowed values: campaign ad_group ad placement
refresh
boolean
spend_from
string | null format: date-time
spend_to
string | null format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
bid
required
Any of:
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
changed_at
required
string | null format: date-time
held
required
boolean
kind
required
string | null
Allowed values: bid budget
last_change
required
Any of:
object
attempts
required
integer format: int32
changed_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
connection
required
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
done_at
required
string | null format: date-time
error_code
required
string
error_message
required
string
id
required
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
kind
required
string | null
Allowed values: pause resume set_bid set_budget
last_call_id
required
string
level
required
string | null
Allowed values: campaign ad_group ad placement
note
required
string
rule
required
Any of:
object
id
required
integer format: int64
name
string
rules_may_change
required
boolean
schedule
required
Any of:
object
id
required
integer format: int64
name
string
state_after
required
string | null
Allowed values: active paused removed other not_found
state_before
required
string | null
Allowed values: active paused removed other not_found
status
required
string | null
Allowed values: pending done already held refused failed expired
took_over
required
string
undo_of
required
string
updated_at
required
string format: date-time
value_after
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
value_asked
required
Any of:
object
ceiling
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
floor
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
from
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
ratio_ppm
required
integer | null format: int64
reset
required
boolean
value
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
value_before
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
workspace_id
required
integer format: int64
read_at
required
string | null format: date-time
rule
required
Any of:
object
id
required
integer format: int64
name
string
since
required
string | null format: date-time
source_status
required
string
state
required
string | null
Allowed values: set inherited managed not_found
tracker_value
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
tracker_wrote_at
required
string | null format: date-time
unit
required
string | null
Allowed values: cpc cpm cpv cpa factor daily
value
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
budget
required
Any of:
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
changed_at
required
string | null format: date-time
held
required
boolean
kind
required
string | null
Allowed values: bid budget
last_change
required
Any of:
object
attempts
required
integer format: int32
changed_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
connection
required
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
done_at
required
string | null format: date-time
error_code
required
string
error_message
required
string
id
required
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
kind
required
string | null
Allowed values: pause resume set_bid set_budget
last_call_id
required
string
level
required
string | null
Allowed values: campaign ad_group ad placement
note
required
string
rule
required
Any of:
object
id
required
integer format: int64
name
string
rules_may_change
required
boolean
schedule
required
Any of:
object
id
required
integer format: int64
name
string
state_after
required
string | null
Allowed values: active paused removed other not_found
state_before
required
string | null
Allowed values: active paused removed other not_found
status
required
string | null
Allowed values: pending done already held refused failed expired
took_over
required
string
undo_of
required
string
updated_at
required
string format: date-time
value_after
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
value_asked
required
Any of:
object
ceiling
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
floor
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
from
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
ratio_ppm
required
integer | null format: int64
reset
required
boolean
value
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
value_before
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
workspace_id
required
integer format: int64
read_at
required
string | null format: date-time
rule
required
Any of:
object
id
required
integer format: int64
name
string
since
required
string | null format: date-time
source_status
required
string
state
required
string | null
Allowed values: set inherited managed not_found
tracker_value
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
tracker_wrote_at
required
string | null format: date-time
unit
required
string | null
Allowed values: cpc cpm cpv cpa factor daily
value
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
changed_at
required
string | null format: date-time
connection
required
object
id
required
integer format: int64
name
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
last_change
required
Any of:
object
attempts
required
integer format: int32
changed_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
connection
required
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
done_at
required
string | null format: date-time
error_code
required
string
error_message
required
string
id
required
string
key
required
object
country
required
string
source_campaign
required
string
values
required
Array<string>
kind
required
string | null
Allowed values: pause resume set_bid set_budget
last_call_id
required
string
level
required
string | null
Allowed values: campaign ad_group ad placement
note
required
string
rule
required
Any of:
object
id
required
integer format: int64
name
string
rules_may_change
required
boolean
schedule
required
Any of:
object
id
required
integer format: int64
name
string
state_after
required
string | null
Allowed values: active paused removed other not_found
state_before
required
string | null
Allowed values: active paused removed other not_found
status
required
string | null
Allowed values: pending done already held refused failed expired
took_over
required
string
undo_of
required
string
updated_at
required
string format: date-time
value_after
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
value_asked
required
Any of:
object
ceiling
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
floor
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
from
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
ratio_ppm
required
integer | null format: int64
reset
required
boolean
value
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
value_before
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
workspace_id
required
integer format: int64
level
required
string | null
Allowed values: campaign ad_group ad placement
paused_by_tracker
required
boolean
person_resumed
required
boolean
read_at
required
string | null format: date-time
sequence
required
integer format: int64
source_status
required
string
spend
required
Array<object>
object
amount_micros
required
integer format: int64
currency
required
string
state
required
string | null
Allowed values: active paused removed other not_found
updated_at
required
string | null format: date-time
workspace_id
required
integer format: int64

Example 

{
  "data": [
    {
      "bid": {
        "kind": "bid",
        "last_change": {
          "changed_by": {
            "kind": "user"
          },
          "kind": "pause",
          "level": "campaign",
          "state_after": "active",
          "state_before": "active",
          "status": "pending"
        },
        "state": "set",
        "unit": "cpc"
      },
      "budget": {
        "kind": "bid",
        "last_change": {
          "changed_by": {
            "kind": "user"
          },
          "kind": "pause",
          "level": "campaign",
          "state_after": "active",
          "state_before": "active",
          "status": "pending"
        },
        "state": "set",
        "unit": "cpc"
      },
      "last_change": {
        "changed_by": {
          "kind": "user"
        },
        "kind": "pause",
        "level": "campaign",
        "state_after": "active",
        "state_before": "active",
        "status": "pending"
      },
      "level": "campaign",
      "state": "active"
    }
  ]
}

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