Create or update the journey conversion goal
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"goal_event_type": "purchase.completed",
"goal_event_filter": {
"product_tier": "pro"
},
"conversion_window_hours": 168,
"description": "Pro-tier purchase within 7 days of enrollment"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal"
payload = {
"goal_event_type": "purchase.completed",
"goal_event_filter": { "product_tier": "pro" },
"conversion_window_hours": 168,
"description": "Pro-tier purchase within 7 days of enrollment"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goal_event_type: 'purchase.completed',
goal_event_filter: {product_tier: 'pro'},
conversion_window_hours: 168,
description: 'Pro-tier purchase within 7 days of enrollment'
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal', 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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal",
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([
'goal_event_type' => 'purchase.completed',
'goal_event_filter' => [
'product_tier' => 'pro'
],
'conversion_window_hours' => 168,
'description' => 'Pro-tier purchase within 7 days of enrollment'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal"
payload := strings.NewReader("{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"goal_event_type": "<string>",
"goal_event_filter": {},
"conversion_window_hours": 123,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Campaigns
Create or update the journey conversion goal
Upserts the conversion-goal definition for a journey campaign — the goal event type (e.g. purchase.completed), an optional JSON event filter, and the post-enrollment conversion-attribution window in hours (default 168 / 7 days; 0 means unbounded attribution). Idempotent: the same call shape creates the goal on first use and edits it thereafter, bumping the updated timestamp each time.
PUT
/
api
/
v1
/
campaigns
/
{id}
/
journey
/
goal
Create or update the journey conversion goal
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"goal_event_type": "purchase.completed",
"goal_event_filter": {
"product_tier": "pro"
},
"conversion_window_hours": 168,
"description": "Pro-tier purchase within 7 days of enrollment"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal"
payload = {
"goal_event_type": "purchase.completed",
"goal_event_filter": { "product_tier": "pro" },
"conversion_window_hours": 168,
"description": "Pro-tier purchase within 7 days of enrollment"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goal_event_type: 'purchase.completed',
goal_event_filter: {product_tier: 'pro'},
conversion_window_hours: 168,
description: 'Pro-tier purchase within 7 days of enrollment'
})
};
fetch('https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal', 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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal",
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([
'goal_event_type' => 'purchase.completed',
'goal_event_filter' => [
'product_tier' => 'pro'
],
'conversion_window_hours' => 168,
'description' => 'Pro-tier purchase within 7 days of enrollment'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal"
payload := strings.NewReader("{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/campaigns/{id}/journey/goal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goal_event_type\": \"purchase.completed\",\n \"goal_event_filter\": {\n \"product_tier\": \"pro\"\n },\n \"conversion_window_hours\": 168,\n \"description\": \"Pro-tier purchase within 7 days of enrollment\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"campaign_id": "<string>",
"goal_event_type": "<string>",
"goal_event_filter": {},
"conversion_window_hours": 123,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
Event that counts as a conversion (dotted namespaces allowed).
Required string length:
1 - 160Optional attribute filter the conversion event must match.
Attribution window in hours after enrollment; 0 disables the window (unbounded).
Required range:
0 <= x <= 8760Maximum string length:
500⌘I