Skip to main content
PUT
/
v1
/
orgs
/
{org_id}
/
actions
/
definitions
/
{id}
/
lanes
/
advice
Set action definition lane advice
curl --request PUT \
  --url https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "tags": {},
  "running_limit_cap": 1,
  "unsettled_limit_cap": 1,
  "confidence_bps": 1,
  "sample_size": 1,
  "feature_window_minutes": 1,
  "expires_at": "2023-11-07T05:31:56Z",
  "ttl_seconds": 2,
  "evidence_summary": "<unknown>"
}
'
{
  "data": {
    "org_id": "<string>",
    "action_definition_id": "<string>",
    "action_variant": "<string>",
    "dispatch_lane": "<string>",
    "tag_dimensions_key": "<string>",
    "confidence_bps": 1,
    "sample_size": 1,
    "feature_window_minutes": 1,
    "computed_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "running_limit_cap": 1,
    "unsettled_limit_cap": 1,
    "tags": {},
    "evidence_summary": "<unknown>"
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Path Parameters

org_id
string
required
Pattern: ^[0-9]+$
id
string
required
Pattern: ^[0-9]+$

Body

application/json
tags
object
running_limit_cap
integer | null
Required range: x >= 0
unsettled_limit_cap
integer | null
Required range: x >= 0
confidence_bps
integer
Required range: x >= 0
sample_size
integer
Required range: x >= 0
feature_window_minutes
integer
Required range: x >= 0
expires_at
string<date-time>
ttl_seconds
integer
Required range: x >= 1
evidence_summary
any

Response

200 - application/json

Default Response

data
object
required
errors
object[] | null
required