Analyse audience overlap across segments
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments/overlap \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segment_ids": [
"seg_high_value",
"seg_newsletter"
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments/overlap"
payload = { "segment_ids": ["seg_high_value", "seg_newsletter"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({segment_ids: ['seg_high_value', 'seg_newsletter']})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments/overlap', 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/contacts/segments/overlap",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'segment_ids' => [
'seg_high_value',
'seg_newsletter'
]
]),
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/contacts/segments/overlap"
payload := strings.NewReader("{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/contacts/segments/overlap")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments/overlap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}Contacts
Analyse audience overlap across segments
Compute the audience overlap across 2-10 contact segments (Braze / Iterable / Customer.io / Segment parity): per-segment current sizes, total intersection_count (members of ALL ids), union_count (members of AT LEAST ONE), the Jaccard index, and the pairwise overlap matrix in input order for the heatmap. Reads the live membership table, so a freshly-refreshed segment shows its true current size.
POST
/
api
/
v1
/
contacts
/
segments
/
overlap
Analyse audience overlap across segments
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments/overlap \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segment_ids": [
"seg_high_value",
"seg_newsletter"
]
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments/overlap"
payload = { "segment_ids": ["seg_high_value", "seg_newsletter"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({segment_ids: ['seg_high_value', 'seg_newsletter']})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments/overlap', 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/contacts/segments/overlap",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'segment_ids' => [
'seg_high_value',
'seg_newsletter'
]
]),
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/contacts/segments/overlap"
payload := strings.NewReader("{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/contacts/segments/overlap")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments/overlap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segment_ids\": [\n \"seg_high_value\",\n \"seg_newsletter\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
The 2-10 segment ids to compare (de-duplicated server-side).
⌘I