Skip to content
Tallyraydocs

Step a tuner now, dry if asked or if it isn't active, and answer its step. A step past 10 seconds goes on to its end: the same Idempotency-Key answers tuner_stepping while it goes, and the step once it's done

POST
/v1/buyer/automation/tuners/{id}/step
curl --request POST \
  --url https://example.com/v1/buyer/automation/tuners/example/step \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dry_run": true }'

Who: a workspace’s buyer, or its key. API keys with the buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
<= 64 characters

Made once per action and sent again on every retry of it, so the service acts once: the request_id of the create or money-moving call; a new one when left out

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
dry_run
required
boolean

Example generated

{
  "dry_run": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
arms
required
Array<object>
object
best_ppm
required
integer format: int64
conversions
required
integer format: int64
cost
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
decisions
required
integer format: int64
high
required
integer format: int64
id
required
integer format: int64
kind
required
string | null
Allowed values: lander offer path
low
required
integer format: int64
mean
required
integer format: int64
name
required
string
observed
required
integer format: int64
revenue
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
state
required
string | null
Allowed values: ready new out
target_bps
required
integer format: int32
weight_after
required
integer format: int32
weight_before
required
integer format: int32
as_of
required
string | null format: date-time
currency
required
string
draws
required
integer format: int32
dry_run
required
boolean
error_code
required
string
error_message
required
string
finished_at
required
string | null format: date-time
from
required
string format: date-time
id
required
string
outcome
required
string | null
Allowed values: moved dry_run steady learning weights_changed target_gone
seed
required
string
started_at
required
string format: date-time
status
required
string | null
Allowed values: running done failed
sticky
required
boolean
to
required
string format: date-time
trigger
required
string | null
Allowed values: schedule manual
tuner
required
object
arms
required
Array<string | null>
Allowed values: lander offer path
campaign
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
floor_bps
required
integer format: int32
flow
required
Any of:
object
id
required
integer format: int64
name
string
id
required
integer format: int64
interval_seconds
required
integer format: int64
lag_seconds
required
integer format: int64
last_outcome
required
string | null
Allowed values: moved dry_run steady learning weights_changed target_gone
last_step_at
required
string | null format: date-time
max_step_bps
required
integer format: int32
measure
required
string | null
Allowed values: epv cr profit
min_conversions
required
integer format: int64
min_visits
required
integer format: int64
name
required
string
next_step_at
required
string | null format: date-time
sequence
required
integer format: int64
status
required
string | null
Allowed values: active dry_run paused archived
stop_reason
required
string | null
Allowed values: turned_off weights_changed target_gone
stopped_at
required
string | null format: date-time
target
required
object
path
required
Any of:
object
id
required
integer format: int64
name
string
rotation
required
Any of:
object
flow
required
object
id
required
integer format: int64
name
string
rule_id
required
integer format: int64
step
required
Any of:
object
path
required
object
id
required
integer format: int64
name
string
step
required
integer format: int32
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
window_seconds
required
integer format: int64
workspace_id
required
integer format: int64
workspace_id
required
integer format: int64

Example 

{
  "arms": [
    {
      "kind": "lander",
      "state": "ready"
    }
  ],
  "outcome": "moved",
  "status": "running",
  "trigger": "schedule",
  "tuner": {
    "arms": [
      "lander"
    ],
    "created_by": {
      "kind": "user"
    },
    "last_outcome": "moved",
    "measure": "epv",
    "status": "active",
    "stop_reason": "turned_off",
    "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"
  }
}