curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/"
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}/contacts/length/', 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}/contacts/length/",
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}/contacts/length/"
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}/contacts/length/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/")
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{
"capped": true,
"count": 123,
"groups": {
"blocked": 123,
"done": 123,
"in_progress": 123,
"needs_approval": 123,
"paused": 123,
"removed": 123
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Count the contacts a filter matches under each tab
How the contacts matching a search or filter split across the Audience tab’s tabs (In progress, Needs approval, Paused, Done, Blocked, Removed), judged as list_sequence_contacts’ ‘group’ lists them under the same filters, so each count is the length of that tab’s filtered list. ‘count’ is every match, the Removed tab’s included: the All tab counts this less groups.removed, or send group__not=removed for the All tab’s count as ‘count’ (groups.removed then reads 0). ‘capped’ says more contacts match than one read judges. The page’s tabs read it while its search box or a filter is on; get_audience_eligibility counts the whole roster. include_tabs=false answers ‘count’ alone, much faster.
curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/"
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}/contacts/length/', 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}/contacts/length/",
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}/contacts/length/"
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}/contacts/length/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/length/")
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{
"capped": true,
"count": 123,
"groups": {
"blocked": 123,
"done": 123,
"in_progress": 123,
"needs_approval": 123,
"paused": 123,
"removed": 123
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Query Parameters
Only contacts in these statuses (everything but, with exclude).
Where one contact stands in one sequence.
ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the
in-flight guard between claim and outcome. PAUSED is a deliberate
per-contact hold: unclaimable because the tick claims strictly on ACTIVE,
yet still LIVE. It keeps its step and its one-live-sequence slot, and a
compliance stop (reply, unsubscribe) reaches it. Everything else is
settled: COMPLETED walked off the end; STOPPED was halted (reply,
unsubscribe, bounce, manual, company pause); FAILED is terminal;
SUPPRESSED was on the do-not-contact list;
SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the
reason visible in the grid.
A contact the workspace's recontact rule refuses is STOPPED with
StopReason.COOLDOWN. There is deliberately no held state: a cooldown
settles a contact rather than parking them, so nothing here waits on a date
and nothing lets itself out later.
AWAITING_ACTION is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand: only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both.
PENDING is a draft's roster: in, standing on a step, and NOT live. Binding
an audience enrols on the spot so the Contacts tab can show who is in, but
a sequence nobody has launched must not hold anybody's one-live-sequence
slot, or a second sequence written for the same people skips them all.
uq_sequence_enrolment_one_live leaves PENDING out, the tick never
claims it, and launch turns each row ACTIVE, settling the ones another
sequence took meanwhile as SKIPPED_DUPLICATE.
pending, active, claimed, paused, awaiting_action, completed, stopped, failed, suppressed, skipped_duplicate Only contacts stopped for these reasons (everything but, with exclude).
reply, unsubscribe, do_not_contact, bounce, manual, company_reply, row_left_audience, row_left_paused, step_removed, removed, cooldown, rejected, mailbox_removed, unread_reply, declined, trashed, trashed_paused Only contacts whose latest settled Browser use run took one of these outcomes, by key (outcome_1 to outcome_8, or needs_human), as each row's browser_outcome says. Never flipped by exclude.
Which way an edge leaves its step.
DEFAULT for message-step flow; YES/NO for a condition's two branches. A connection request leaves by the answer it got: CONNECTED (accepted, and already connected unless that has a branch of its own), ALREADY_CONNECTED (present only when the request splits it out) and NOT_ACCEPTED.
A Browser use step leaves by the outcome its run reached: OUTCOME_1 to
OUTCOME_8 are fixed slots whose words the step's browser_config holds
(a slot is never given to a second outcome once its first is removed), and
NEEDS_HUMAN is the way every run may end, when the site wanted something
only a person can give. Fixed slots rather than free keys, so a branch
still fits the stored columns, the edge's unique constraint and every
reader of this enum.
default, yes, no, connected, already_connected, not_accepted, outcome_1, outcome_2, outcome_3, outcome_4, outcome_5, outcome_6, outcome_7, outcome_8, needs_human With step_id: 'waiting' for the contacts still live on the step (due, held, paused, or waiting for an approval), 'failed' for those the step failed for. Each is the list behind the number the step's card shows. Where a contact stands on one step of the Builder, as the step's card counts them.
The card's numbers are not the Audience tab's tabs: a live contact no address reaches is waiting on its card and Blocked on the roster, and a bounce is Blocked but never a failure of the step. A number on a card is always the length of the list it opens.
waiting, failed With step_id, instead of step_state: the contacts the step sent down this arm this journey (a check's 'yes' or 'no', a connection request's or a Browser use step's named arm). The list behind the number on the arm in the Builder. Which way an edge leaves its step.
DEFAULT for message-step flow; YES/NO for a condition's two branches. A connection request leaves by the answer it got: CONNECTED (accepted, and already connected unless that has a branch of its own), ALREADY_CONNECTED (present only when the request splits it out) and NOT_ACCEPTED.
A Browser use step leaves by the outcome its run reached: OUTCOME_1 to
OUTCOME_8 are fixed slots whose words the step's browser_config holds
(a slot is never given to a second outcome once its first is removed), and
NEEDS_HUMAN is the way every run may end, when the site wanted something
only a person can give. Fixed slots rather than free keys, so a branch
still fits the stored columns, the edge's unique constraint and every
reader of this enum.
default, yes, no, connected, already_connected, not_accepted, outcome_1, outcome_2, outcome_3, outcome_4, outcome_5, outcome_6, outcome_7, outcome_8, needs_human Response
Successful Response
How the contacts a roster filter matches split across the Audience tab's tabs.
Was this page helpful?