Segmenty
Ukládejte filtry nad kontakty, vypisujte, kdo jim odpovídá, a procházejte vývoj sledovaných segmentů v čase.
Vytvoření segmentu
Vytvoří segment: uložený filtr nad kontakty workspace. Vyžaduje API klíč s oprávněním full.
Segment obsahuje kontakty ze svého zdroje (odběratele seznamů v audience_ids, nebo všechny kontakty, když je prázdné), které odpovídají jeho conditions. Členství se vyhodnocuje živě pokaždé, když se segment počítá, vypisuje, zobrazuje v náhledu nebo ho použije odesílaná kampaň. Viz Segmenty.
Každý tarif zahrnuje určitý počet segmentů na workspace, sledovaných i nesledovaných. Viz Limity a kvóty.
/segmentsParametry v těle požadavku
namestringpovinnédescriptionstring | nullaudience_idsstring[]aud_…) v tomto workspace, nejvýše 100. Segment obsahuje jen kontakty přihlášené aspoň k jednomu z nich. Prázdná hodnota nebo vynechání znamená všechny kontakty ve workspace.conditionsobjecttrackedbooleanvýchozí: falsePodmínky
conditions obsahuje skupiny pravidel. match na nejvyšší úrovni spojuje skupiny a match každé skupiny spojuje její pravidla:
{
"match": "all",
"groups": [
{ "match": "any", "rules": [{ "field": "email_domain", "operator": "in", "value": ["acme.com", "globex.io"] }] },
{ "match": "all", "rules": [{ "field": "status", "operator": "equals", "value": "subscribed" }] }
]
}matchjeall(výchozí), neboany, na nejvyšší úrovni i v každé skupině.- Pokud chcete zahrnout všechny ze zdroje, vynechte
conditions, nebo nepošlete žádné skupiny. Prázdné skupiny se zahodí. - Přijímá se i plochý tvar
{ "match": "any", "rules": [...] }, který se uloží jako jedna skupina. - Segment může mít nejvýše 10 skupin a celkem 50 pravidel.
Pole
| Pole | Typ | Poznámky |
|---|---|---|
email |
string | |
email_domain |
string | Část adresy za @. |
first_name, last_name |
string | |
status |
enum | subscribed (kontakt není globálně odhlášený a je přihlášený aspoň k jednomu seznamu kontaktů, takže ho kampaně zasáhnou), nebo unsubscribed. Operátory: equals, not_equals. |
created_at, updated_at |
datetime | Kdy byl kontakt vytvořen nebo naposledy změněn, porovnává se v UTC. |
audience |
audience | Členství s přihlášením. in odpovídá kontaktům přihlášeným k některému ze seznamů s danými ID, not_in kontaktům, které nejsou přihlášené k žádnému z nich. |
tags |
tags | Štítky kontaktu. Hodnoty se porovnávají převedené na malá písmena. |
score |
score | Skóre kontaktu. |
custom_fields.<key> |
podle pole | Textová pole jsou string, číselná number, datová date (YYYY-MM-DD), logická boolean, výběrová enum a vícevýběrová multi. |
orders_count, total_spent, average_order_value |
metric | Z objednávek kontaktu. U kontaktů bez objednávek 0. Částky jsou v měně objednávek kontaktu. |
first_order_at, last_order_at |
moment | U kontaktů bez objednávek nenastavené. |
expected_next_order_at |
moment | Poslední objednávka plus průměrný odstup mezi objednávkami kontaktu. Nastavuje se od druhé objednávky a může být v budoucnosti. |
churn_risk |
enum | low, medium nebo high: doba od poslední objednávky porovnaná s obvyklým odstupem kontaktu (nejméně 14 dní), u jednorázových kupujících s 90 dny. Bez objednávek nenastavené. |
last_active_at |
moment | Kdy měřicí skript naposledy zaznamenal kontakt na vašem webu. |
purchased |
purchase | Objednávky, viz Pravidla aktivity. |
viewed_product |
view | Zobrazení produktů zaznamenaná měřicím skriptem. |
cart |
cart | Otevřené a opuštěné košíky. |
used_coupon |
coupon | Objednávky, ve kterých byl použit slevový kód. |
campaign_activity |
campaign_activity | Přijaté, otevřené nebo prokliknuté e-maily z kampaní. |
Výpis polí pro segmenty vrací pole vašeho workspace včetně vlastních polí a seznamů kontaktů s operátory, které každé z nich přijímá.
Operátory
| Typ | Operátory |
|---|---|
| string | equals, not_equals, contains, not_contains, starts_with, ends_with, in, not_in, is_set, is_not_set |
| number | equals, not_equals, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_set, is_not_set |
| date | on, before, after, between, in_last_days, more_than_days_ago, in_next_days, is_set, is_not_set |
| datetime | on, before, after, between, in_last_days, more_than_days_ago |
| boolean | is_true, is_false, is_set, is_not_set |
| enum | in, not_in, is_set, is_not_set |
| multi | in (má některou z hodnot), contains_all (má všechny hodnoty), not_in (nemá žádnou z hodnot), is_set, is_not_set |
| audience | in, not_in |
| tags | in (má některý ze štítků), contains_all (má všechny štítky), not_in (nemá žádný ze štítků), is_set (má nějaký štítek), is_not_set (nemá žádné štítky) |
| score | equals, not_equals, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between |
| metric | equals, not_equals, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between |
| moment | on, before, after, between, in_last_days, more_than_days_ago, in_next_days, is_set, is_not_set |
| purchase, view, coupon | has, has_not |
| cart | has_open_cart, has_abandoned_cart, has_no_open_cart |
| campaign_activity | received, not_received, opened, not_opened, clicked, not_clicked, received_not_opened, received_not_clicked |
Hodnoty
- Textová porovnání u polí typu string nerozlišují velikost písmen. Hodnoty výběrových a vícevýběrových polí se musí shodovat přesně.
not_equals,not_containsanot_inodpovídají i kontaktům, které hodnotu nemají.in,not_inacontains_allpřijímají seznam nejvýše 100 hodnot. Textové hodnoty mohou mít nejvýše 500 znaků.betweenpřijímá[from, to]včetně obou mezí: dvě čísla, nebo dvě dataYYYY-MM-DD.on,beforeaafterpřijímají datumYYYY-MM-DD.beforeaafterdaný den nezahrnují.in_last_days,more_than_days_agoain_next_dayspřijímají celý počet dní od 1 do 3 650, počítaný od okamžiku vyhodnocení segmentu. Datová vlastní pole porovnávají kalendářní dny v UTC;created_ataupdated_atpoužívají přesné časy, takžein_last_dayss hodnotou7znamená posledních 7 × 24 hodin.is_set,is_not_set,is_trueais_falsehodnotu nepřijímají.is_trueodpovídá hodnotámtrue,1,yesaon;is_falsehodnotámfalse,0,noaoff.- Uložené pravidlo, které už neplatí, například po změně typu jeho vlastního pole, neodpovídá žádným kontaktům. Pravidla pro smazané vlastní pole dál fungují podle hodnot, které kontakty stále mají, ale nová pravidla musí používat existující pole.
Pravidla aktivity
purchased, viewed_product, cart, used_coupon a campaign_activity přijímají jako value objekt. Všechny klíče jsou volitelné.
| Pole | Klíče hodnoty |
|---|---|
purchased |
days: jen objednávky z posledních N dní. product_ids: objednávky s některým z těchto produktů (ID produktů ve vašem obchodě). categories: objednávky s produktem z některé z těchto kategorií. min_count: aspoň tolik odpovídajících objednávek (výchozí hodnota 1, nejvýše 1 000). Zrušené objednávky se nepočítají. |
viewed_product |
days, product_ids, categories a min_count jako výše, počítají se ale zobrazení produktů. |
cart |
days jen s has_abandoned_cart: košíky opuštěné za posledních N dní. has_open_cart odpovídá aktivnímu košíku, has_no_open_cart kontaktům bez aktivního i opuštěného košíku. |
used_coupon |
days a coupon: klíč jednoho kuponu. Bez coupon se počítá jakýkoli kód. |
campaign_activity |
campaign_id: jedna kampaň (cmp_...), bez něj jakákoli kampaň. days: jen posledních N dní, bez něj celá historie. |
days je celé číslo od 1 do 3 650. has_not je opakem has se stejnou hodnotou.
{
"match": "all",
"groups": [
{ "match": "all", "rules": [
{ "field": "purchased", "operator": "has", "value": { "categories": ["Shoes"], "days": 180 } },
{ "field": "churn_risk", "operator": "in", "value": ["medium", "high"] },
{ "field": "campaign_activity", "operator": "clicked", "value": { "days": 90 } }
] }
]
}received_not_opened a received_not_clicked odpovídají kontaktům, které dostaly aspoň jeden odpovídající e-mail z kampaně a žádný z nich neotevřely, respektive v žádném neklikly. Otevření jsou přibližná: Apple Mail načítá obrázky každého e-mailu, který přijme.
Odpověď
Vrací 201 Created s objektem segmentu včetně contacts_count a subscribed_count. Nový sledovaný segment začíná s tracking.status nastaveným na syncing, zatímco Emailit zaznamenává jeho aktuální členy.
| Stavový kód | Kdy |
|---|---|
400 |
Chybí name, nebo má některé pole špatný typ. |
403 |
tracked je true a tarif sledované segmenty nezahrnuje. Tělo odpovědi je {"error": "plan_required", "required_plan": "pro", ...}. |
422 |
Některé pole nebo pravidlo je neplatné: klíči v errors jsou jejich cesty, například conditions.groups.0.rules.1.value, a message opakuje první problém. Vrací se také, když workspace dosáhl limitu segmentů svého tarifu; takové tělo obsahuje usage.used a usage.limit. |
{
"object": "segment",
"id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"name": "Pro customers renewing soon",
"description": null,
"audience_ids": ["aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a"],
"conditions": {
"match": "all",
"groups": [
{
"match": "all",
"rules": [
{ "field": "custom_fields.plan", "operator": "in", "value": ["pro", "enterprise"] },
{ "field": "custom_fields.renews_on", "operator": "in_next_days", "value": 30 }
]
}
]
},
"tracked": true,
"tracking": {
"status": "syncing",
"synced_at": null
},
"contacts_count": 412,
"subscribed_count": 398,
"created_at": "2026-10-18T12:00:00.000000+00:00",
"updated_at": "2026-10-18T12:00:00.000000+00:00"
}{
"error": "plan_required",
"message": "Tracked segments are included with Pro and Business.",
"required_plan": "pro"
}{
"message": "Validation failed. conditions.groups.0.rules.1.value: Enter a whole number of days between 1 and 3650.",
"errors": {
"conditions.groups.0.rules.1.value": [
"Enter a whole number of days between 1 and 3650."
]
}
}{
"error": "Pay as you go includes 3 segments.",
"message": "Pay as you go includes 3 segments.",
"usage": {
"used": 3,
"limit": 3
}
}Načtení segmentu
Načte segment a spočítá jeho kontakty v okamžiku volání. Vyžaduje API klíč s oprávněním full.
/segments/{id}Parametry v cestě
idstringpovinnéseg_…).Odpověď
Vrací objekt segmentu.
objectstringsegment.idstringseg_.namestringdescriptionstring | nullaudience_idsstring[]conditionsobject{ "match", "groups": [{ "match", "rules": [...] }] }. Viz Vytvoření segmentu.trackedbooleantrackingobject | nullnull u segmentů, které nejsou sledované. U sledovaných segmentů:
status:active, když se členové udržují aktuální,syncing, zatímco Emailit po vytvoření segmentu nebo obnovení sledování zaznamenává aktuální členy, nebopaused, když tarif workspace už sledované segmenty nezahrnuje.synced_at: kdy se celý segment naposledy porovnal se svými pravidly, nebonullpřed prvním porovnáním.
contacts_countintegersubscribed_countintegercontacts_count, které mohou kampaně odesílat: kontakty, které nejsou globálně odhlášené a jsou přihlášené aspoň k jednomu seznamu kontaktů. Blokované adresy se stále započítávají.created_at, updated_atstringPokud segment neexistuje, vrací 404.
{
"object": "segment",
"id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"name": "Pro customers renewing soon",
"description": "Pro and Enterprise plans that renew in the next 30 days.",
"audience_ids": ["aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a"],
"conditions": {
"match": "all",
"groups": [
{
"match": "all",
"rules": [
{ "field": "custom_fields.plan", "operator": "in", "value": ["pro", "enterprise"] },
{ "field": "custom_fields.renews_on", "operator": "in_next_days", "value": 30 }
]
}
]
},
"tracked": true,
"tracking": {
"status": "active",
"synced_at": "2026-10-18T00:30:04.211000+00:00"
},
"contacts_count": 412,
"subscribed_count": 398,
"created_at": "2026-10-02T09:14:03.551000+00:00",
"updated_at": "2026-10-02T09:14:03.551000+00:00"
}{
"error": "Segment not found"
}Úprava segmentu
Upraví pole, která předáte, a ostatní ponechá beze změny. audience_ids a conditions se nahrazují celé. Vyžaduje API klíč s oprávněním full.
Kampaně vyhodnocují segment při odeslání, takže nová pravidla platí pro každou kampaň, která se ještě neodeslala, včetně naplánovaných.
U sledovaného segmentu změna audience_ids nebo conditions porovná uložené členy s novými pravidly. Kontakty, které kvůli změně vstoupí nebo odejdou, odešlou události segment.contact_added a segment.contact_removed s reason nastaveným na segment_updated. Webhooky je dostanou, ale automatizace nespouštějí.
/segments/{id}Parametry v cestě
idstringpovinnéseg_…).Parametry v těle požadavku
namestringdescriptionstring | nullnull nebo prázdný řetězec ji smaže.audience_idsstring[][] znamená všechny kontakty ve workspace.conditionsobjecttrackedbooleanOdpověď
Vrací upravený objekt segmentu s aktuálními počty.
| Stavový kód | Kdy |
|---|---|
404 |
Segment neexistuje. |
422 |
Některé pole nebo pravidlo je neplatné, nebo se tracked liší od současné hodnoty segmentu. Klíči v errors jsou cesty k polím. |
{
"object": "segment",
"id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"name": "Pro customers renewing this month",
"description": "Pro and Enterprise plans that renew in the next 30 days.",
"audience_ids": ["aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a"],
"conditions": {
"match": "all",
"groups": [
{
"match": "all",
"rules": [
{ "field": "custom_fields.plan", "operator": "in", "value": ["pro", "enterprise"] },
{ "field": "custom_fields.renews_on", "operator": "in_next_days", "value": 30 }
]
}
]
},
"tracked": true,
"tracking": {
"status": "active",
"synced_at": "2026-10-18T00:30:04.211000+00:00"
},
"contacts_count": 412,
"subscribed_count": 398,
"created_at": "2026-10-02T09:14:03.551000+00:00",
"updated_at": "2026-10-18T12:00:00.000000+00:00"
}{
"error": "Segment not found"
}{
"message": "Validation failed. tracked: Tracking is chosen when a segment is created and can't be changed. Create a new segment instead.",
"errors": {
"tracked": [
"Tracking is chosen when a segment is created and can't be changed. Create a new segment instead."
]
}
}Výpis segmentů
Vrací segmenty workspace od nejnovějšího a kolik segmentů z tarifu je využito. Vyžaduje API klíč s oprávněním full.
/segmentsParametry dotazu
pageintegervýchozí: 1limitintegervýchozí: 10searchstringwith_countsbooleanvýchozí: falsecontacts_count a subscribed_count. Počítání vyhodnocuje každý segment na stránce, proto je ve výchozím stavu vypnuté.matchstringHodnota all (výchozí) vyžaduje shodu se všemi filtry. S hodnotou or stačí shoda s kterýmkoli filtrem. Viz Filtrování.
orderstringKlíč řazení pro tento výpis. Viz klíče řazení níže.
directionstringasc, nebo desc.
Klíče filtrů
Filtry se zadávají parametry dotazu ve tvaru key.condition=value, například name.contains=customers nebo created_at.after=2026-09-01. Podmínky pro jednotlivé typy najdete na stránce Filtrování.
| Klíč | Typ | Poznámky |
|---|---|---|
name |
string | |
created_at |
date | |
updated_at |
date |
Klíče řazení pro order: name, created_at, updated_at.
Odpověď
dataobject[]total_recordsintegerusageobjectused (všechny segmenty, sledované i nesledované), limit (počet segmentů, které tarif zahrnuje) a tracking_allowed (jestli tarif zahrnuje sledované segmenty). Viz Limity a kvóty.next_page_urlstring | nullnull na poslední stránce. Obsahuje jen page a limit; když na ni přejdete, přidejte znovu vyhledávání a filtry.previous_page_urlstring | nullnull na první stránce.{
"data": [
{
"object": "segment",
"id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"name": "Pro customers renewing soon",
"description": "Pro and Enterprise plans that renew in the next 30 days.",
"audience_ids": ["aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a"],
"conditions": {
"match": "all",
"groups": [
{
"match": "all",
"rules": [
{ "field": "custom_fields.plan", "operator": "in", "value": ["pro", "enterprise"] },
{ "field": "custom_fields.renews_on", "operator": "in_next_days", "value": 30 }
]
}
]
},
"tracked": true,
"tracking": {
"status": "active",
"synced_at": "2026-10-18T00:30:04.211000+00:00"
},
"contacts_count": 412,
"subscribed_count": 398,
"created_at": "2026-10-02T09:14:03.551000+00:00",
"updated_at": "2026-10-02T09:14:03.551000+00:00"
}
],
"total_records": 1,
"usage": {
"used": 1,
"limit": 10,
"tracking_allowed": true
},
"next_page_url": null,
"previous_page_url": null
}Smazání segmentu
Smaže segment. Vyžaduje API klíč s oprávněním full.
- Segment nelze smazat, dokud ho používá kampaň, která je naplánovaná, ve frontě, odesílá se nebo se testuje. Nejdřív změňte příjemce kampaně.
- Segment nelze smazat, dokud ho kterákoli nesmazaná automatizace v jakémkoli stavu používá: ve spouštěči Added to segment nebo Removed from segment, v cíli, kroku Wait until nebo podmínce ukončení na tyto události, nebo v pravidle Segment v podmínce. Nejdřív tyto automatizace změňte.
- Koncepty kampaní, které segmentu odesílají, ho ztratí ze svých příjemců a
removed_from_campaignsudává, kolika konceptů se to týká. Koncepty, které segment vylučují, si vyloučení ponechají, takže je nelze odeslat, dokud ho nenahradíte: jeho vypuštění by kampaň poslalo lidem, které jste chtěli vynechat. Odeslané, zrušené a archivované kampaně si odkaz ponechají jako historii. - U sledovaného segmentu se smažou i jeho uložení členové a historie růstu.
/segments/{id}Parametry v cestě
idstringpovinnéseg_…).Odpověď
objectstringsegment.idstringnamestringdeletedbooleantrue.removed_from_campaignsinteger| Stavový kód | Kdy |
|---|---|
404 |
Segment neexistuje. |
409 |
Segment používá kampaň, která je naplánovaná, ve frontě, odesílá se nebo se testuje, nebo z něj vychází automatizace. Zpráva je jmenovitě uvádí. |
{
"object": "segment",
"id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"name": "Pro customers renewing soon",
"deleted": true,
"removed_from_campaigns": 1
}{
"error": "This segment is used by campaigns that are scheduled or sending: October launch. Change their recipients first.",
"message": "This segment is used by campaigns that are scheduled or sending: October launch. Change their recipients first."
}{
"error": "This segment is used by automations: Renewal reminder. Change their triggers, conditions or exit conditions first.",
"message": "This segment is used by automations: Renewal reminder. Change their triggers, conditions or exit conditions first."
}{
"error": "Segment not found"
}Výpis kontaktů segmentu
Vrací kontakty, které segmentu odpovídají v okamžiku volání, od nejnovějších. Vyžaduje API klíč s oprávněním full.
/segments/{id}/contactsParametry v cestě
idstringpovinnéseg_…).Parametry dotazu
pageintegervýchozí: 1limitintegervýchozí: 25searchstringmatchstringHodnota all (výchozí) vyžaduje shodu se všemi filtry. S hodnotou or stačí shoda s kterýmkoli filtrem. Viz Filtrování.
orderstringKlíč řazení pro tento výpis. Viz klíče řazení níže.
directionstringasc, nebo desc.
Klíče filtrů
Kontakty segmentu přijímají stejné klíče filtrů a řazení jako Výpis kontaktů; filtry se uplatní navíc k segmentu, například email.ends_with=acme.com.
Filtry výpisů jsou jedna úroveň parametrů dotazu ve tvaru key.condition=value. Parametry match, order a direction a seznam podmínek pro každý typ najdete na stránce Filtrování.
Klíče filtrů
| Klíč | Typ | Podmínky | Poznámky |
|---|---|---|---|
email | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | |
first_name | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | |
last_name | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | |
name | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | Křestní jméno a příjmení bez mezer na začátku a na konci. |
audiences | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | Porovnává se s názvem seznamu kontaktů, který je u kontaktu abecedně první. |
created_at | date | exact, before, after, empty, not_empty | |
updated_at | date | exact, before, after, empty, not_empty | |
unsubscribed | boolean | exact, not_exact | |
audience_id | string | exact, not_exact | Jen exact a not_exact. Hodnota je ID seznamu kontaktů (aud_...). |
custom_fields.* | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | Místo * zadejte klíč vlastního pole, například custom_fields.company.contains=Acme. |
Klíče řazení
V parametru order předejte jeden z těchto klíčů a v parametru direction hodnotu asc, nebo desc: email, first_name, last_name, name, audiences, created_at, updated_at, unsubscribed
Odpověď
dataobject[]object, id, email, first_name, last_name, custom_fields, unsubscribed, audiences (id, name, subscribed), created_at a updated_at. Kontakty sledovaného segmentu mají navíc joined_at.data[].joined_atstring | nullnull, dokud sledování kontakt nezaznamená, například hned poté, co kontakt začal segmentu odpovídat, dokud je segment ve stavu syncing, nebo dokud je sledování ve stavu paused.total_recordsintegersubscribed_countintegernext_page_urlstring | nullnull na poslední stránce. Obsahuje page, limit a search; když na ni přejdete, přidejte znovu filtry.previous_page_urlstring | nullnull na první stránce.Pokud segment neexistuje, vrací 404.
{
"data": [
{
"object": "contact",
"id": "con_2nYs7Ab3Kd9Lm1Qw5Er8Ty2Ui4o",
"email": "ada@acme.com",
"first_name": "Ada",
"last_name": "Lovelace",
"custom_fields": {
"plan": "pro",
"renews_on": "2026-10-20"
},
"unsubscribed": false,
"audiences": [
{
"id": "aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a",
"name": "Customers",
"subscribed": true
}
],
"created_at": "2026-03-11T08:00:00.000000+00:00",
"updated_at": "2026-09-30T16:42:10.000000+00:00",
"joined_at": "2026-10-03T00:30:02.874000+00:00"
}
],
"total_records": 1,
"subscribed_count": 1,
"next_page_url": null,
"previous_page_url": null
}{
"error": "Segment not found"
}Načtení růstu segmentu
Vrací historii sledovaného segmentu: jeden řádek na každý den v UTC, od nejstaršího, končí dneškem. Z těchto dat vychází graf Growth na stránce segmentu. Vyžaduje API klíč s oprávněním full.
Historie začíná se zahájením sledování. Kontakty zaznamenané prvním zápisem členů po vytvoření segmentu nebo po obnovení sledování se počítají jako členové, ale ne jako vstupy.
/segments/{id}/growthParametry v cestě
idstringpovinnéseg_…).Parametry dotazu
daysintegervýchozí: 30Odpověď
objectstringsegment_growth.segment_idstringdataobject[]data[].datestringYYYY-MM-DD.data[].members_countinteger | nullnull.data[].joined_countintegerdata[].left_countinteger| Stavový kód | Kdy |
|---|---|
404 |
Segment neexistuje. |
422 |
Segment není sledovaný. |
{
"object": "segment_growth",
"segment_id": "seg_2nYs9Kd1Lq3vB8wXcE4fT7uRm0p",
"data": [
{ "date": "2026-10-12", "members_count": null, "joined_count": 0, "left_count": 0 },
{ "date": "2026-10-13", "members_count": 380, "joined_count": 0, "left_count": 0 },
{ "date": "2026-10-14", "members_count": 391, "joined_count": 14, "left_count": 3 },
{ "date": "2026-10-15", "members_count": 391, "joined_count": 0, "left_count": 0 },
{ "date": "2026-10-16", "members_count": 402, "joined_count": 12, "left_count": 1 },
{ "date": "2026-10-17", "members_count": 405, "joined_count": 6, "left_count": 3 },
{ "date": "2026-10-18", "members_count": 412, "joined_count": 9, "left_count": 2 }
]
}{
"error": "Growth is recorded for tracked segments only.",
"message": "Growth is recorded for tracked segments only."
}{
"error": "Segment not found"
}Náhled segmentu
Zkontroluje definici segmentu bez uložení: vrátí, kolik kontaktů jí odpovídá, a jejich vzorek. Definice se validuje stejně jako u endpointu Vytvoření segmentu a náhled se nepočítá do limitu segmentů v tarifu. Vyžaduje API klíč s oprávněním full.
/segments/previewParametry v těle požadavku
audience_idsstring[]conditionsobjectlimitintegervýchozí: 10Odpověď
objectstringsegment_preview.audience_idsstring[]conditionsobject{ match, rules } se změní na jednu skupinu a prázdné skupiny se zahodí.contacts_countintegersubscribed_countintegercontactsobject[]Pokud je definice neplatná, vrací 422 s errors, jehož klíči jsou cesty k polím.
{
"object": "segment_preview",
"audience_ids": [],
"conditions": {
"match": "all",
"groups": [
{
"match": "all",
"rules": [
{ "field": "email_domain", "operator": "equals", "value": "acme.com" }
]
}
]
},
"contacts_count": 8,
"subscribed_count": 8,
"contacts": [
{
"object": "contact",
"id": "con_2nYs7Ab3Kd9Lm1Qw5Er8Ty2Ui4o",
"email": "ada@acme.com",
"first_name": "Ada",
"last_name": "Lovelace",
"custom_fields": {
"plan": "pro",
"renews_on": "2026-10-20"
},
"unsubscribed": false,
"audiences": [
{
"id": "aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a",
"name": "Customers",
"subscribed": true
}
],
"created_at": "2026-03-11T08:00:00.000000+00:00",
"updated_at": "2026-09-30T16:42:10.000000+00:00"
}
]
}{
"message": "Validation failed. conditions.groups.0.rules.0.operator: \"greater_than\" does not apply to Email domain.",
"errors": {
"conditions.groups.0.rules.0.operator": [
"\"greater_than\" does not apply to Email domain."
]
}
}Výpis polí pro segmenty
Vrací pole, která mohou pravidla segmentů v tomto workspace používat: pole kontaktu, každé vlastní pole (s typem podle typu vlastního pole), členství v seznamech kontaktů, nákupní data a zapojení do kampaní. Vyžaduje API klíč s oprávněním full.
/segments/fieldsOdpověď
dataobject[]data[].keystringfield pravidla, například email_domain nebo custom_fields.plan.data[].labelstringdata[].typestringstring, number, date, datetime, boolean, enum, multi, audience, metric, moment, purchase, view, cart, coupon nebo campaign_activity. Viz Vytvoření segmentu. Pole aktivity, například purchased, přijímají jako hodnotu objekt, viz Pravidla aktivity.data[].groupstringcontact, custom_fields, audiences, commerce (nákupní data) nebo engagement (aktivita v kampaních).data[].operatorsstring[]data[].valuesobject[]value a label: možnosti výběrových a vícevýběrových vlastních polí, subscribed a unsubscribed pro status a seznamy kontaktů workspace pro audience. U ostatních polí chybí.{
"data": [
{
"key": "email",
"label": "Email",
"type": "string",
"group": "contact",
"operators": ["equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "in", "not_in", "is_set", "is_not_set"]
},
{
"key": "status",
"label": "Subscription status",
"type": "enum",
"group": "contact",
"operators": ["equals", "not_equals"],
"values": [
{ "value": "subscribed", "label": "Subscribed" },
{ "value": "unsubscribed", "label": "Unsubscribed" }
]
},
{
"key": "audience",
"label": "Audience",
"type": "audience",
"group": "audiences",
"operators": ["in", "not_in"],
"values": [
{ "value": "aud_2nYs8Qm4Hc1Zx7Vb3Ne6Tg9Lk2a", "label": "Customers" }
]
},
{
"key": "purchased",
"label": "Purchased",
"type": "purchase",
"group": "commerce",
"operators": [
"has",
"has_not"
]
},
{
"key": "custom_fields.renews_on",
"label": "Renews on",
"type": "date",
"group": "custom_fields",
"operators": ["on", "before", "after", "between", "in_last_days", "more_than_days_ago", "in_next_days", "is_set", "is_not_set"]
}
]
}