Skip to content
Tallyraydocs

Make a tuner of a path's landers or offers (path_id with its flow_id or campaign_id), or of a rotation's paths: its measure, window, lag, interval and bounds. It's active unless status says dry_run or paused

POST
/v1/buyer/automation/tuners
curl --request POST \
  --url https://example.com/v1/buyer/automation/tuners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "arms": [ "lander" ], "campaign_id": 1, "floor_bps": 1, "flow_id": 1, "interval_seconds": 1, "lag_seconds": 1, "max_step_bps": 1, "measure": "epv", "min_conversions": 1, "min_visits": 1, "path_id": 1, "rotation": { "flow_id": 1, "rule_id": 1 }, "status": "active", "step": { "path_id": 1, "step": 1 }, "window_seconds": 1 }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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
arms
Array<string> | null
Allowed values: lander offer path
campaign_id
integer | null format: int64
floor_bps
integer | null format: int32
flow_id
integer | null format: int64
interval_seconds
integer | null format: int64
lag_seconds
integer | null format: int64
max_step_bps
integer | null format: int32
measure
string | null
Allowed values: epv cr profit
min_conversions
integer | null format: int64
min_visits
integer | null format: int64
path_id
integer | null format: int64
rotation
Any of:
object
flow_id
required
integer format: int64
rule_id
required
integer format: int64
status
string | null
Allowed values: active dry_run paused archived
step
Any of:
object
path_id
required
integer format: int64
step
required
integer format: int32
window_seconds
integer | null format: int64

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
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

Example 

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