Preview a replacement audience before choosing how existing journeys continue
curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/', 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.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"already_present": 123,
"capped": true,
"duplicate_rows": 123,
"existing_contacts": 123,
"in_cooldown": 123,
"in_other_sequence": 123,
"keep": {
"added": 123,
"not_changed": 123,
"pauses_sending": true,
"removed": 123
},
"missing_contact": 123,
"new_contacts": 123,
"ongoing_contacts": 123,
"outside_selection": 123,
"previously_contacted": 123,
"restart": {
"added": 123,
"not_changed": 123,
"pauses_sending": true,
"removed": 123
},
"restart_blocked": 123,
"restart_ready": 123,
"same_table": true,
"selected_rows": 123,
"source": "<string>",
"suppressed": 123,
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}sequences
Preview a replacement audience before choosing how existing journeys continue
Reads the table or saved view the sequence would draw from, the way enrolment would after the change, and says for each choice (keep existing journeys, or start them fresh) how many contacts are added, removed and not changed. On the same table, keeping journeys applies the new filter: contacts it no longer selects stop. Writes nothing.
GET
/
sequences
/
{sequence_id}
/
audience
/
replacement-preview
/
Preview a replacement audience before choosing how existing journeys continue
curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/', 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.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/audience/replacement-preview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"already_present": 123,
"capped": true,
"duplicate_rows": 123,
"existing_contacts": 123,
"in_cooldown": 123,
"in_other_sequence": 123,
"keep": {
"added": 123,
"not_changed": 123,
"pauses_sending": true,
"removed": 123
},
"missing_contact": 123,
"new_contacts": 123,
"ongoing_contacts": 123,
"outside_selection": 123,
"previously_contacted": 123,
"restart": {
"added": 123,
"not_changed": 123,
"pauses_sending": true,
"removed": 123
},
"restart_blocked": 123,
"restart_ready": 123,
"same_table": true,
"selected_rows": 123,
"source": "<string>",
"suppressed": 123,
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
APIKeyHeaderHTTPBearer
Path Parameters
Response
Successful Response
What keeping existing journeys does.
Show child attributes
Show child attributes
What starting every journey fresh does.
Show child attributes
Show child attributes
The sequence already reads this table. Keeping journeys then applies the new filter to its contacts: those it no longer selects stop.
Was this page helpful?