Skip to content
Tallyraydocs

Rules: active, in dry run and paused unless status says

GET
/v1/buyer/automation/rules
curl --request GET \
  --url 'https://example.com/v1/buyer/automation/rules?sort=id' \
  --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

status
string
campaign_id
string
q
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
action
required
string | null
Allowed values: block_placement pause_path pause_campaign warn pause_source_campaign pause_source_ad_group pause_source_ad set_bid set_budget
campaign_ids
required
Array<integer>
change
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
max_step_bps
required
integer format: int32
step
required
Any of:
object
amount
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
kind
required
string | null
Allowed values: up_percent down_percent up_amount down_amount to_amount to_share
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
percent_bps
required
integer format: int32
share_bps
required
integer format: int32
target
required
Any of:
object
confidence_bps
required
integer format: int32
cpa
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
epc_share_bps
required
integer | null format: int32
kind
required
string | null
Allowed values: cpa roi epc
lower_only
required
boolean
roi_ppm
required
integer | null format: int64
unit
required
string | null
Allowed values: cpc cpm cpv cpa factor daily
conditions
required
Array<object>
object
comparison
required
string | null
Allowed values: less less_or_equal equal greater_or_equal greater
measure
required
string | null
Allowed values: visits unique_visits clicks ctr conversions cr revenue pending_revenue cost profit roi epv epc cpv cpa bot_share automation_score impressions ictr cpm
money
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
value
required
integer | null format: int64
connection
required
Any of:
object
id
required
integer format: int64
name
string
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
email_actions
required
boolean
id
required
integer format: int64
interval_seconds
required
integer format: int64
lag_seconds
required
integer format: int64
last_run_at
required
string | null format: date-time
last_run_status
required
string | null
Allowed values: running succeeded failed
limits
required
object
cooldown_seconds
required
integer format: int64
per_day
required
integer format: int32
per_run
required
integer format: int32
min_visits
required
integer format: int64
name
required
string
next_run_at
required
string | null format: date-time
raises_approved_at
required
string | null format: date-time
raises_approved_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
run_dates
required
Any of:
object
from
required
string format: date-time
to
required
string format: date-time
run_hours
required
Any of:
object
hours
required
Array<integer>
time_zone
required
string
sequence
required
integer format: int64
status
required
string | null
Allowed values: active dry_run paused archived
subject
required
string | null
Allowed values: placement path campaign source_campaign source_ad_group source_ad
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
warnings
required
Array<string | null>
Allowed values: visits_only no_spend_report
window_seconds
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": [
    {
      "action": "block_placement",
      "change": {
        "step": {
          "kind": "up_percent",
          "measure": "visits"
        },
        "target": {
          "kind": "cpa"
        },
        "unit": "cpc"
      },
      "conditions": [
        {
          "comparison": "less",
          "measure": "visits"
        }
      ],
      "created_by": {
        "kind": "user"
      },
      "last_run_status": "running",
      "raises_approved_by": {
        "kind": "user"
      },
      "status": "active",
      "subject": "placement",
      "updated_by": {
        "kind": "user"
      },
      "warnings": [
        "visits_only"
      ]
    }
  ]
}

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