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 '
{
"destination_id": "<string>",
"tags": {},
"running_limit_cap": 1,
"unsettled_limit_cap": 1,
"confidence_bps": 1,
"sample_size": 1,
"expires_at": "2023-11-07T05:31:56Z",
"ttl_seconds": 2,
"evidence_summary": "<unknown>"
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice"
payload = {
"destination_id": "<string>",
"tags": {},
"running_limit_cap": 1,
"unsettled_limit_cap": 1,
"confidence_bps": 1,
"sample_size": 1,
"expires_at": "2023-11-07T05:31:56Z",
"ttl_seconds": 2,
"evidence_summary": "<unknown>"
}
headers = {
"x-arklow-auth": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-arklow-auth': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination_id: '<string>',
tags: {},
running_limit_cap: 1,
unsettled_limit_cap: 1,
confidence_bps: 1,
sample_size: 1,
expires_at: '2023-11-07T05:31:56Z',
ttl_seconds: 2,
evidence_summary: '<unknown>'
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'destination_id' => '<string>',
'tags' => [
],
'running_limit_cap' => 1,
'unsettled_limit_cap' => 1,
'confidence_bps' => 1,
'sample_size' => 1,
'expires_at' => '2023-11-07T05:31:56Z',
'ttl_seconds' => 2,
'evidence_summary' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arklow-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice"
payload := strings.NewReader("{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-arklow-auth", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-arklow-auth"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"org_id": "<string>",
"action_definition_id": "<string>",
"action_variant": "<string>",
"dispatch_lane": "<string>",
"tag_dimensions_key": "<string>",
"confidence_bps": 1,
"sample_size": 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>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Set action definition lane advice
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 '
{
"destination_id": "<string>",
"tags": {},
"running_limit_cap": 1,
"unsettled_limit_cap": 1,
"confidence_bps": 1,
"sample_size": 1,
"expires_at": "2023-11-07T05:31:56Z",
"ttl_seconds": 2,
"evidence_summary": "<unknown>"
}
'import requests
url = "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice"
payload = {
"destination_id": "<string>",
"tags": {},
"running_limit_cap": 1,
"unsettled_limit_cap": 1,
"confidence_bps": 1,
"sample_size": 1,
"expires_at": "2023-11-07T05:31:56Z",
"ttl_seconds": 2,
"evidence_summary": "<unknown>"
}
headers = {
"x-arklow-auth": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-arklow-auth': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination_id: '<string>',
tags: {},
running_limit_cap: 1,
unsettled_limit_cap: 1,
confidence_bps: 1,
sample_size: 1,
expires_at: '2023-11-07T05:31:56Z',
ttl_seconds: 2,
evidence_summary: '<unknown>'
})
};
fetch('https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'destination_id' => '<string>',
'tags' => [
],
'running_limit_cap' => 1,
'unsettled_limit_cap' => 1,
'confidence_bps' => 1,
'sample_size' => 1,
'expires_at' => '2023-11-07T05:31:56Z',
'ttl_seconds' => 2,
'evidence_summary' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arklow-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice"
payload := strings.NewReader("{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-arklow-auth", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice")
.header("x-arklow-auth", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arklow.io/v1/orgs/{org_id}/actions/definitions/{id}/lanes/advice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-arklow-auth"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination_id\": \"<string>\",\n \"tags\": {},\n \"running_limit_cap\": 1,\n \"unsettled_limit_cap\": 1,\n \"confidence_bps\": 1,\n \"sample_size\": 1,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"ttl_seconds\": 2,\n \"evidence_summary\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"org_id": "<string>",
"action_definition_id": "<string>",
"action_variant": "<string>",
"dispatch_lane": "<string>",
"tag_dimensions_key": "<string>",
"confidence_bps": 1,
"sample_size": 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>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Body
application/json
Show child attributes
Show child attributes
Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 1