Automatizace
Sestavujte workflow ze spouštěčů a kroků, spouštějte je a procházejte jejich spuštění.
- POST/automations
- GET/automations/{id}
- POST/automations/{id}
- GET/automations
- DEL/automations/{id}
- POST/automations/{id}/start
- POST/automations/{id}/pause
- POST/automations/{id}/stop
- POST/automations/{id}/trigger
- GET/automations/{id}/runs
- GET/automations/{id}/runs/{run_id}
- POST/automations/{id}/runs/{run_id}/cancel
- POST/automations/{id}/exit
- GET/automations/runs
- GET/automations/{id}/stats
- GET/automations/{id}/steps/{step_key}/stats
Vytvoření automatizace
Vytvoří automatizaci ve stavu draft z grafu kroků a propojení. Vyžaduje API klíč s oprávněním full. Automatizace jsou v betaverzi.
Dokud automatizaci nezapnete, nic nedělá. Každé spuštění stojí při startu 3 kredity a každý e-mail odeslaný akcí send_email nebo forward_email stojí 1 kredit navíc. V neověřeném workspace mohou tyto akce odesílat jen na e-mailové adresy účtů členů workspace.
/automationsParametry v těle požadavku
contextstringpovinnécontact, email nebo event. Kontext určuje, které spouštěče a akce můžete použít, a později ho nelze změnit. Viz Kontexty.namestringpovinnédescriptionstring | nullsettingsobjectstepsobject[]povinnéconnectionsobject[]povinné[]. Viz Propojení.Nastavení
exit_conditionsobject[]Zruší spuštění kontaktu, jakmile se splní některá z těchto podmínek (kontext contact, nejvýše 20). Každá položka je buď definice události, tedy název spouštěče v event a jeho konfigurační pole, například { "event": "contact.tag_added", "tag": "customer" } nebo { "event": "contact.on_event", "event_name": "purchase" }, nebo podmínka nad kontaktem { "condition": { "match": "all", "rules": [...] } } s pravidly akce condition. Definice událostí přijímají všechny spouštěče kontaktu kromě datových spouštěčů a contact.visits_url a volitelný filter jako konfigurace spouštěčů. Události segmentů (s povinným segment_id) a události e-commerce jsou v alfaverzi, stejně jako jejich spouštěče. Definice contact.on_event, tady i v krocích goal a wait_until, vyžadují tarif Pro, Business nebo Custom. Viz Podmínky ukončení a cíle.
exit_on_audience_removalbooleanvýchozí: falsetrue zruší spuštění zahájené spouštěčem contact.added_to_audience, když je kontakt z daného seznamu kontaktů odebrán, když se z něj odhlásí nebo když se odhlásí ze všech marketingových e-mailů.on_step_failurestringvýchozí: stopstop při selhání kroku převede spuštění do stavu failed. skip neúspěšný krok zaznamená a pokračuje po jeho hranách default (nebo no po neúspěšné akci condition).allow_reentrybooleanvýchozí: truefalse přeskočí aktivaci spouštěče, pokud má stejný kontakt (nebo e-mail) v této automatizaci už probíhající spuštění.max_concurrent_runsintegervýchozí: 0running. 0 znamená bez limitu.cooldown_secondsintegervýchozí: 0Kroky
keystringpovinnéwelcome_email. Propojení, statistiky kroků a úpravy odkazují na kroky klíčem.typestringpovinnétrigger, nebo action.triggerstringactionstringconfigobjectPropojení
fromstringpovinnétostringpovinnébranchstringvýchozí: defaultfrom pokračuje po této hraně. Kroky condition používají yes a no, kroky wait_until matched a timeout (události a podmínky), nebo default a passed (data), kroky experiment klíče variant. Všechny ostatní kroky používají default.Kontexty
| Kontext | Čeho se spuštění týká | Spouštěče | Pravidla |
|---|---|---|---|
contact |
Jednoho kontaktu. send_email odesílá tomuto kontaktu. |
contact.*, system.* |
Jeden nebo více spouštěčů. Všechny musí vést do stejné první akce. |
email |
Jednoho e-mailu (odeslaného, nebo přijatého). | email.*, system.* |
Jeden nebo více spouštěčů. Všechny musí vést do stejné první akce. |
event |
Jen obsahu spouštěče. | event.*, system.* |
Právě jeden spouštěč. |
Každá akce musí být dosažitelná ze spouštěče. Spuštění začne v akci propojené se spouštěčem, který se aktivoval, a pokračuje po propojeních:
conditionpokračuje jen po hraně, jejížbranchje podle výsledkuyes, nebono.wait_untilpokračuje jen pomatched, nebotimeout(události a podmínky), případně podefault, nebopassed(data).experimentpokračuje po hranách vybrané varianty. Když tato cesta skončí, spuštění pokračuje po hranáchdefaultkroku experimentu.waitodloží další krok.- Všechny ostatní akce pokračují po svých hranách
default. Krok s několika odchozími hranami pokračuje po všech. - Ke kroku
goalse lze dostat i mimo pořadí: když kontakt cíl splní, spuštění na něj přeskočí a pokračuje za ním.
Spuštění přejde do stavu completed, když nezbývají žádné kroky nebo se provede krok end_run, do stavu failed, když krok selže (při on_step_failure: "stop"), a do stavu canceled, když se splní podmínka ukončení, spuštění se zruší nebo automatizaci zastavíte.
Spouštěče
| Spouštěč | Kontext | Kdy se aktivuje |
|---|---|---|
contact.added_to_audience |
contact | Kontakt se přihlásí k odběru seznamu kontaktů, včetně opětovného přihlášení. |
contact.removed_from_audience |
contact | Odběratel se ze seznamu kontaktů smaže. |
contact.added_to_segment |
contact | Kontakt vstoupí do sledovaného segmentu. Neplatí pro změny způsobené úpravou segmentu. Alfaverze: spouštěče segmentů může přidávat jen tým Emailitu; ostatní požadavky vracejí 403 s error: "segments_alpha". |
contact.removed_from_segment |
contact | Kontakt opustí sledovaný segment. Neplatí pro změny způsobené úpravou segmentu. Alfaverze, stejně jako contact.added_to_segment. |
contact.created |
contact | Vytvoří se kontakt. |
contact.updated |
contact | Kontakt se upraví, včetně štítků a skóre. |
contact.tag_added, contact.tag_removed |
contact | Kontaktu se přidá nebo odebere štítek. |
contact.score_changed |
contact | Změní se skóre kontaktu. |
contact.unsubscribed |
contact | Kontakt se odhlásí ze seznamu kontaktů, nebo ze všech marketingových e-mailů. |
contact.loaded_email |
contact | Příjemce, který je kontaktem ve workspace, otevře e-mail. |
contact.clicked_in_email |
contact | Příjemce, který je kontaktem ve workspace, klikne na měřený odkaz. |
contact.on_date |
contact | Nastane datum z datového vlastního pole, volitelně posunuté o dny nebo týdny, v určitý čas dne v daném časovém pásmu. Jednou, nebo s repeat: "yearly" každý rok. |
contact.date_anniversary |
contact | Každý rok v měsíc a den z datového vlastního pole, se stejnými možnostmi. |
contact.on_event |
contact | Vlastní událost (c:) nebo událost workspace (w:) pro kontakt. Tarify Business a Custom: ostatní tarify dostanou 403 s error: "plan_required" a required_plan: "business". |
form.submitted |
contact | Odešle se formulář s e-mailovou adresou. |
contact.on_purchase |
contact | Kontakt zadá novou objednávku. Alfaverze: spouštěče e-commerce může přidávat jen tým Emailitu; ostatní požadavky vracejí 403 s error: "commerce_alpha". |
contact.abandoned_cart |
contact | Košík kontaktu se stane opuštěným. Alfaverze, stejně jako contact.on_purchase. |
contact.visits_url |
contact | Přijímá se, ale Emailit ho zatím neaktivuje. |
email.received |
Dorazí příchozí e-mail. | |
email.delivered, email.bounced, email.complained, email.loaded, email.clicked, email.failed, email.suppressed, email.canceled |
Nastane stejnojmenná událost e-mailu. | |
event.<name> |
event | Jakýkoli název, který začíná na event.. Emailit zatím události event.* nevyvolává; automatizace s kontextem event spouštějte přes system.manual. |
system.manual |
všechny | Zavoláte Ruční spuštění. |
system.schedule |
všechny | Přijímá se, ale Emailit plánované spouštěče zatím neaktivuje. |
Pole config spouštěče:
audience_idstringcontact.added_to_audience a contact.removed_from_audience: spouštěč se aktivuje jen pro tento seznam kontaktů (aud_…).segment_idstringcontact.added_to_segment a contact.removed_from_segment: sledovaný segment (seg_…). Při vytvoření automatizace je volitelný, při úpravě jejích kroků povinný. Segment, který neexistuje nebo není sledovaný, vrací 400.include_current_membersbooleanvýchozí: falsecontact.added_to_segment: při prvním zapnutí automatizace zahájí spuštění také pro každý kontakt, který už v segmentu je. Nastavení opakovaného vstupu stále platí.date_fieldstringcontact.date_anniversary a contact.on_date: klíč vlastního pole, které obsahuje datum, například birthday.offset, time, timezone, repeatobject, string, string, stringoffset je { "amount": 3, "unit": "days", "direction": "before" } (unit je days, nebo weeks), time je HH:MM (výchozí 00:00), timezone název IANA (výchozí UTC) a repeat u contact.on_date hodnota once, nebo yearly.tagstringcontact.tag_added a contact.tag_removed: jen tento štítek.threshold, directionnumber, stringcontact.score_changed: jen když skóre překročí threshold, směrem up (výchozí), nebo down.fieldstringcontact.updated: jen když se změnilo toto pole, například custom_fields.purchased, tags nebo score.event_namestringcontact.on_event: název události, například purchase (odpovídá c:purchase i w:purchase) nebo w:webinar.attended. Když ho vynecháte, spouštěč se aktivuje pro jakoukoli událost workspace nebo vlastní událost. Podle vlastností události filtrujte přes filter, například properties.total.automation_id, campaign_id, link_containsstringform_idstringform.submitted: jen tento formulář.filterobjectSpouštěč se aktivuje, jen když událost odpovídá: { "match": "all", "rules": [{ "field": "subject", "operator": "contains", "value": "Invoice" }] }. match je all (výchozí), nebo any. field je cesta s tečkami do pole object události, například to nebo email.subject; úvodní payload. se ignoruje.
Operátory: equals, not_equals, contains, not_contains, starts_with, ends_with, greater_than, less_than, in, not_in, is_set, is_not_set. Všechny operátory kromě is_set a is_not_set potřebují value; in a not_in přijímají pole.
Akce
| Akce | Kontext | Konfigurace |
|---|---|---|
send_email |
všechny | type (povinné, template), template_id (povinné: ID tem_ nebo alias publikované šablony), from, subject, reply_to, to, email_type, tracking |
forward_email |
email, event | to (povinné), from, subject, email_id |
wait |
všechny | seconds (povinné, od 0 do 2 592 000, tedy 30 dní) |
wait_until |
všechny (režimy event a condition: contact) |
mode (date, event nebo condition) a pole daného režimu |
condition |
všechny | filter (povinné, viz Podmínky) |
goal |
contact | event, nebo condition, if_not_met |
experiment |
všechny | variants (povinné), control |
call_webhook |
všechny | url (povinné), method, headers, body, secret, fail_on_error |
run_automation |
všechny | automation_id (povinné), exit_current |
exit_automation |
contact | automation_ids, nebo all: true |
end_run |
všechny | Žádná |
end |
všechny | Žádná |
add_tag, remove_tag |
contact | tags (povinné) |
update_score |
contact | operation (add, subtract nebo set), value (povinné) |
add_to_audience |
contact | audience_id (povinné), emit_events |
remove_from_audience |
contact | audience_id (povinné), mode (remove, nebo unsubscribe), emit_events |
update_subscription |
contact | action (subscribe, nebo unsubscribe, povinné), scope (audience, all_audiences nebo global), audience_id |
edit_contact |
contact | fields (povinné), emit_events |
add_to_suppressions |
email, event | type, reason, email |
remove_from_suppressions |
email, event | email |
create_contact |
email, event | email, first_name, audience_id, emit_events |
send_emailodešle šablonu. Ve výchozím stavu se jakofrompoužije odesílatel šablony; adresa musí být na ověřené odesílací doméně.subjectpřepíše předmět šablony.reply_toje adresa, nebo pole adres a může obsahovat proměnnou. V kontextucontactjde e-mail kontaktu daného spuštění; v kontextechemailaeventnastavteto.email_typejemarketing(výchozí v kontextucontact: přeskočí odhlášené kontakty a přidá odkaz pro odhlášení a hlavičkyList-Unsubscribe), nebotransactional.tracking: { "loads": true, "clicks": true }přepíše nastavení měření domény atracking: {}se k němu vrátí.wait_untilčeká na datum:{ "mode": "date", "date": { "type": "global", "key": "webinar_date" }, "offset": { "amount": 1, "unit": "days", "direction": "before" }, "time": "09:00", "timezone": "Europe/Prague", "if_passed": "continue" }, kdedate.typejecontact(sfield),global(skey),fixed(svalue) nebopayload(spath) aif_passedjecontinue, nebobranch. Na událost:{ "mode": "event", "event": { "event": "contact.clicked_in_email" }, "timeout": { "amount": 2, "unit": "days" } }. Na podmínku:{ "mode": "condition", "condition": { ... }, "timeout": ... }. Čekání trvá nejvýše 365 dní. Viz Wait until.goalpřijímá definici události vevent(stejně jakoexit_conditions), nebocondition. Když kontakt cíl splní, spuštění na něj přeskočí.if_not_met(continue,waitneboend) určuje, co se stane, když spuštění dojde k cíli dřív, než ho kontakt splní. Cíle vyžadují tarif Pro, Business nebo Custom.forward_emailpřepošle e-mail daného spuštění (nebo e-mail zemail_id) na adresu vto. Výchozí hodnotafromje původní odesílatel a výchozí hodnotasubjectjeFwd: <original subject>.conditionpřijímá{ "match": "all" | "any", "rules": [...] }. Viz Podmínky. Krok pokračuje větvíyes, nebono.experimentnáhodně podle váhy vybere jednu zvariants(acontrol), každou ve tvaru{ "key": "a", "weight": 50 }, a pokračuje větví pojmenovanou podle vybraného klíče.call_webhookpošle HTTP požadavek (výchozí metodaPOST,Content-TypeJSON) a zaznamená třídu stavového kódu (2xx,4xx,5xx), případnětimeoutnebonetwork_error. Bezbodypošle automatizaci, spuštění, kontakt a obsah jako JSON. Sesecretse tělo podepíše v hlavičceX-Emailit-Signature. Odpověď s jiným kódem než 2xx neznamená selhání kroku, pokudfail_on_errornemá hodnotutrue. Soukromé adresy jsou blokované.run_automationspustí jinou běžící automatizaci pro stejný kontakt s obsahem tohoto spuštění. Aktuální spuštění pokračuje, nebo sexit_current: trueskončí.exit_automationzruší probíhající spuštění kontaktu v automatizacích zautomation_ids, nebo sall: trueve všech ostatních automatizacích.end_runukončí spuštění včetně ostatních větví.endukončí jen vlastní větev.add_tagaremove_tagmění štítky kontaktu.update_scoremění skóre kontaktu.update_subscriptionpřihlásí nebo odhlásí kontakt z jednoho seznamu kontaktů, ze všech seznamů (jenunsubscribe), nebo ze všech marketingových e-mailů (global).remove_from_audiencesmaže členství kontaktu v seznamu (mode: "remove", výchozí), nebo ho v seznamu ponechá jako odhlášený (mode: "unsubscribe").emit_events(výchozí hodnotatrue) uadd_to_audience,remove_from_audience,create_contactaedit_contactposílá obvyklé událostisubscriber.*acontact.*, takže je dostanou webhooky a spustí se jiné automatizace. Kroky uložené před 2026-10-20 majíemit_events: falsea jejich krokyremove_from_audiencemajímode: "unsubscribe".edit_contactpřijímáfields: [{ "key": "first_name", "value": "Ada" }]. Klíčeemail,first_name,last_nameaunsubscribedupraví kontakt; jakýkoli jiný klíč (s předponoucustom_fields., nebo bez ní) nastaví vlastní pole a hodnotu převede na jeho typ.operationjeset(výchozí),clear,incrementnebodecrement.add_to_suppressionszablokuje adresu daného spuštění (výchozítypejerecipient, výchozíreasonjeautomation).remove_from_suppressionsblokaci odebere. V kontextueventpředejteemail.create_contactvytvoří kontakt (nebo najde existující) a volitelně ho přihlásí k odběru seznamuaudience_id. V kontextuemailje výchozí hodnotouemailpříjemce e-mailu.
Textové hodnoty v konfiguraci jakékoli akce mohou obsahovat proměnné, které Emailit doplní při provedení kroku: {{contact.email}}, {{cf.plan}}, {{global.webinar_link}}, {{email.mail_from}}, {{payload.object.subject}} nebo {{meta.source_event_id}}, například "to": "{{email.mail_from}}". Šablony odeslané akcí send_email i její subject se vykreslují jazykem Temple a mají přímo k dispozici i pole kontaktu, například {{ first_name }}, {{tags}} a {{score}}.
Podmínky
Filtr condition (a také podmínky v wait_until a goal a exit_conditions) má tvar { "match": "all" | "any", "rules": [...] }. Pravidlo je { "field", "operator", "value" }, nebo vnořená skupina { "match", "rules" }, nejvýše 3 úrovně a 50 pravidel.
field |
operator |
value |
|---|---|---|
Pole kontaktu (email, first_name, last_name, created_at, unsubscribed, score), subscribed, custom_fields.<key>, global.<key>, payload.<path>, meta.<path>, contact.<path>, email.<path> |
equals, not_equals, contains, not_contains, starts_with, ends_with, in, not_in, is_set, is_not_set, greater_than, less_than, greater_or_equal, less_or_equal, is_true, is_false, before, after, on, is_past, is_future, within_last, within_next, more_than_ago, more_than_from_now |
Hodnota. Operátory se dny přijímají počet dní nebo { "amount", "unit" }. U is_set, is_not_set, is_true, is_false, is_past a is_future není potřeba. |
tags |
contains, not_contains, in, not_in, is_set, is_not_set |
Štítek, nebo pole štítků pro in a not_in. |
audience |
is_subscribed, is_not_subscribed, is_member, is_not_member |
ID seznamu kontaktů (aud_…). |
engagement |
opened, not_opened, clicked, not_clicked |
"run", "automation", { "scope": "step", "step": "<key>" }, { "scope": "any", "days": 30 } nebo { "scope": "campaign", "campaign_id": "cmp_…" }. |
segment |
is_member, is_not_member |
ID segmentu (seg_…), sledovaného i běžného. Alfaverze. |
commerce.<field> |
Operátory daného pole ze segmentů, kromě pěti, které používají názvy z této tabulky: greater_or_equal, less_or_equal, within_last, within_next a more_than_ago |
Hodnota, kterou přijímá pravidlo segmentu. Alfaverze. Viz níže. |
Pole bez předpony se vyhodnotí vůči kontaktu (first_name, custom_fields.plan), nebo e-mailu (rcpt_to, subject) daného spuštění. subscribed má hodnotu true, když kontakt může dostávat marketingové e-maily.
Pravidla commerce.<field> používají pole e-commerce ze segmentů a vyhodnocují se stejně: orders_count, total_spent, average_order_value, first_order_at, last_order_at, expected_next_order_at, last_active_at, churn_risk, purchased, viewed_product, used_coupon a cart, například { "field": "commerce.purchased", "operator": "has", "value": { "days": 30, "product_ids": ["sku-1"] } }. Pravidla segmentů a e-commerce jsou v alfaverzi: ostatní požadavky, které je přidávají, vracejí 403 s error segments_alpha, nebo commerce_alpha. Automatizace, které je už mají, dál fungují pro všechny.
Odpověď
Vrací 201 Created s automatizací v poli data, včetně ID každého kroku (aus_…) a propojení. status je draft.
Při vytvoření se kontroluje struktura grafu: názvy spouštěčů a akcí pro daný kontext, jedinečnost klíčů, platnost propojení a větví, dosažitelnost, settings a to, že každá adresa from v akci send_email používá ověřenou odesílací doménu. Nekontroluje se, zda je konfigurace každé akce úplná; to dělá Úprava automatizace. Chyby vracejí 400 s polem errors, jehož klíče jsou cesty k polím.
Funkce, které tarif workspace nezahrnuje, vracejí 403 s error: "plan_required", nejnižším tarifem, který je obsahuje, v required_plan a polem message. Kroky goal a definice contact.on_event v exit_conditions, goal a wait_until vyžadují pro a spouštěč contact.on_event vyžaduje business.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "draft",
"settings": { "allow_reentry": false },
"last_triggered_at": null,
"published_at": null,
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-01T09:41:05.318274+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
},
{
"id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
"key": "wait_1_day",
"type": "action",
"trigger": null,
"action": "wait",
"config": { "seconds": 86400 }
},
{
"id": "aus_3HOgOzxaXBgVRpLFtpvJNo4vd5c",
"key": "is_free_user",
"type": "action",
"trigger": null,
"action": "condition",
"config": {
"filter": {
"match": "all",
"rules": [{ "field": "custom_fields.plan", "operator": "is_not_set" }]
}
}
},
{
"id": "aus_3gCI5SWMPFVhOSawR6nz8sF55wp",
"key": "upgrade_tips",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "getting-started-tips" }
},
{
"id": "aus_3Pq7Wd2LxN8cVt5RmK0sHy4BfJe",
"key": "done",
"type": "action",
"trigger": null,
"action": "end",
"config": {}
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" },
{ "from": "welcome_email", "to": "wait_1_day", "branch": "default" },
{ "from": "wait_1_day", "to": "is_free_user", "branch": "default" },
{ "from": "is_free_user", "to": "upgrade_tips", "branch": "yes" },
{ "from": "is_free_user", "to": "done", "branch": "no" }
]
},
"message": "Automation was successfully created.",
"notify": true
}{
"message": "Validation failed.",
"errors": {
"steps.1.action": ["Action \"forward_email\" is not allowed for context \"contact\"."],
"steps": ["Action step \"upgrade_tips\" is not reachable from any trigger."]
}
}Načtení automatizace
Načte automatizaci s celým grafem. Vyžaduje API klíč s oprávněním full.
/automations/{id}Parametry v cestě
idstringpovinnéaut_…).Odpověď
Vrací automatizaci v poli data.
idstringaut_.contextstringcontact, email nebo event.namestringdescriptionstring | nullstatusstringdraft, running, paused, stopped nebo archived.settingsobjecton_step_failure, allow_reentry, max_concurrent_runs, cooldown_seconds. Prázdné, pokud jste žádné nenastavili.last_triggered_atstring | nullpublished_atstring | nullstepsobject[]id (aus_…), key, type, trigger, action a config. Podrobnosti spuštění odkazují na kroky podle id, statistiky podle key.connectionsobject[]from a to a její branch.Význam jednotlivých spouštěčů, akcí a nastavení najdete na stránce Vytvoření automatizace. Pokud automatizace neexistuje nebo byla smazána, vrací 404.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "running",
"settings": { "allow_reentry": false },
"last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-03T14:12:40.551870+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
},
{
"id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
"key": "wait_1_day",
"type": "action",
"trigger": null,
"action": "wait",
"config": { "seconds": 86400 }
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" },
{ "from": "welcome_email", "to": "wait_1_day", "branch": "default" }
]
}
}{
"message": "Automation not found."
}Úprava automatizace
Upraví název, popis, nastavení nebo graf automatizace. Vyžaduje API klíč s oprávněním full. Kontext nelze změnit.
Pokud chcete změnit graf, pošlete steps a connections společně; nahradí aktuální graf. Kroky, jejichž key už existuje, si ponechají ID a historii spuštění, kroky, které vynecháte, se smažou, a nové klíče se přidají. Na rozdíl od vytvoření úprava validuje i konfiguraci každé akce (například send_email potřebuje type a template_id, wait potřebuje seconds). Když si krok ponechá svůj key i akci, nastavení, která v jeho config vynecháte, si ponechají uložené hodnoty: email_type a tracking u send_email, emit_events u kroků pro kontakty a mode u remove_from_audience. Pokud chcete nastavení změnit, pošlete ho; tracking: {} se vrátí k nastavení měření domény.
Než změníte graf běžící automatizace, automatizaci pozastavte a pak ji znovu zapněte, aby se nové spouštěče projevily.
/automations/{id}Parametry v cestě
idstringpovinnéaut_…).Parametry v těle požadavku
namestringdescriptionstringsettingsobjectexit_conditions, exit_on_audience_removal, on_step_failure, allow_reentry, max_concurrent_runs, cooldown_seconds. Viz Nastavení. Nové podmínky ukončení platí pro probíhající spuštění, a to i u běžících automatizací.stepsobject[]connections. Viz Kroky.connectionsobject[]steps. Viz Propojení.Odpověď
Vrací upravenou automatizaci v poli data spolu s message a notify. Pokud validace selže, vrací 400 s polem errors, jehož klíče jsou cesty k polím, pokud úprava přidává krok, spouštěč nebo podmínku ukončení, které tarif nezahrnuje, 403 s error: "plan_required" (viz Vytvoření automatizace) a pokud automatizace neexistuje, 404. Co už automatizace má, zůstane povolené i po přechodu na nižší tarif.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series (v2)",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "paused",
"settings": { "allow_reentry": false, "on_step_failure": "skip" },
"last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-04T08:15:22.730115+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" }
]
},
"message": "Automation was successfully updated.",
"notify": true
}{
"message": "Validation failed.",
"errors": {
"steps.2.config.seconds": ["Wait seconds cannot exceed 2592000 (30 days)."],
"steps.1.config.template_id": ["Template ID is required when type is \"template\"."]
}
}{
"message": "Automation not found."
}Výpis automatizací
Vrátí automatizace workspace od nejnovějších, bez jejich kroků a propojení. Vyžaduje API klíč s oprávněním full. Smazané automatizace se nevypisují.
/automationsParametry dotazu
pageintegervýchozí: 1per_pageintegervýchozí: 25filter[context]stringcontact, email nebo event.filter[status]stringdraft, running, paused, stopped nebo archived.filter[name]stringsortstringvýchozí: created_atname, created_at, updated_at nebo last_triggered_at.orderstringvýchozí: descasc, nebo desc.Můžete také použít obecné filtry key.condition=value na name, status, context a created_at, spolu s match. Viz Filtrování.
Odpověď
dataobject[]id, context, name, description, status, settings, last_triggered_at, published_at, created_at, updated_at. settings je v tomto výpisu vždy prázdný objekt; pokud ho chcete přečíst, načtěte automatizaci.total_recordsintegerper_pageintegercurrent_pageintegertotal_pagesinteger{
"data": [
{
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "running",
"settings": {},
"last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-03T14:12:40.551870+00:00"
}
],
"total_records": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1
}Smazání automatizace
Smaže automatizaci. Zmizí z výpisů a přestane reagovat na spouštěče. Vyžaduje API klíč s oprávněním full.
Spuštění, která už probíhají, se nezruší. Pokud je chcete zrušit, automatizaci zastavte dřív, než ji smažete.
/automations/{id}Parametry v cestě
idstringpovinnéaut_…).Odpověď
Vrací pole message, které smazání potvrzuje. Pokud automatizace neexistuje nebo už byla smazána, vrací 404.
{
"message": "Automation was deleted successfully.",
"notify": true
}{
"message": "Automation not found."
}Zapnutí automatizace
Převede automatizaci do stavu running. Od té chvíle odpovídající spouštěče zahajují spuštění; události, které nastaly před zapnutím, ne. Vyžaduje API klíč s oprávněním full.
Zapnout můžete automatizaci ve stavu draft, paused nebo stopped. První zapnutí nastaví published_at. Jen při prvním zapnutí zahájí spouštěče contact.added_to_segment s include_current_members: true spuštění také pro každý kontakt, který už je v jejich sledovaném segmentu.
Při zapnutí se graf znovu nevaliduje. Pokud jste automatizaci sestavili přes Vytvoření automatizace, které kontroluje jen strukturu, ujistěte se, že je konfigurace každé akce úplná, nebo graf jednou pošlete přes Úpravu automatizace, která ho zvaliduje úplně. Krok s neúplnou konfigurací selže, jakmile na něj spuštění dojde.
/automations/{id}/startParametry v cestě
idstringpovinnéaut_…).Odpověď
Vrací automatizaci v poli data s polem status nastaveným na running. Pokud automatizace neexistuje, vrací 404.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "running",
"settings": { "allow_reentry": false },
"last_triggered_at": null,
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-01T10:00:02.204118+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" }
]
},
"message": "Automation was successfully started.",
"notify": true
}{
"message": "Automation not found."
}Pozastavení automatizace
Převede automatizaci do stavu paused. Její spouštěče přestanou zahajovat nová spuštění, ale už probíhající spuštění pokračují, včetně těch, která čekají na kroku wait. Vyžaduje API klíč s oprávněním full.
Pokud chcete zrušit i probíhající spuštění, automatizaci místo toho zastavte. Spouštěče znovu aktivujete tím, že automatizaci opět zapnete.
/automations/{id}/pauseParametry v cestě
idstringpovinnéaut_…).Odpověď
Vrací automatizaci v poli data s polem status nastaveným na paused. Pokud automatizace neexistuje, vrací 404.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "paused",
"settings": { "allow_reentry": false },
"last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-04T08:10:51.004732+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" }
]
},
"message": "Automation was successfully paused.",
"notify": true
}{
"message": "Automation not found."
}Zastavení automatizace
Převede automatizaci do stavu stopped a zruší každé spuštění, které je ještě ve stavu running; tato spuštění dostanou stav canceled a jejich zbývající kroky se neprovedou. Vyžaduje API klíč s oprávněním full.
Zastavení je dostupné jen přes API. Pokud chcete, aby probíhající spuštění pokračovala, automatizaci místo toho pozastavte. Zastavenou automatizaci můžete znovu zapnout; nová spuštění začnou od začátku.
/automations/{id}/stopParametry v cestě
idstringpovinnéaut_…).Odpověď
Vrací automatizaci v poli data s polem status nastaveným na stopped. Pokud automatizace neexistuje, vrací 404.
{
"data": {
"id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"context": "contact",
"name": "Welcome series",
"description": "Welcome new subscribers, then nudge free users a day later.",
"status": "stopped",
"settings": { "allow_reentry": false },
"last_triggered_at": "2026-10-03T14:12:40.551870+00:00",
"published_at": "2026-10-01T10:00:02.204118+00:00",
"created_at": "2026-10-01T09:41:05.318274+00:00",
"updated_at": "2026-10-05T16:45:09.882301+00:00",
"steps": [
{
"id": "aus_3ZqpuxjmL1szZ8og6uGL1mT6QEJ",
"key": "joined",
"type": "trigger",
"trigger": "contact.added_to_audience",
"action": null,
"config": { "audience_id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV" }
},
{
"id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"key": "welcome_email",
"type": "action",
"trigger": null,
"action": "send_email",
"config": { "type": "template", "template_id": "welcome", "from": "Acme <hello@acme.com>" }
}
],
"connections": [
{ "from": "joined", "to": "welcome_email", "branch": "default" }
]
},
"message": "Automation was successfully stopped.",
"notify": true
}{
"message": "Automation not found."
}Ruční spuštění
Aktivuje spouštěč system.manual s obsahem, který zvolíte. Automatizace musí být ve stavu running a mít krok se spouštěčem system.manual; jinak se žádné spuštění nezahájí. Vyžaduje API klíč s oprávněním full. Ruční spouštěče jsou dostupné jen přes API.
Spuštění se zahájí asynchronně a stojí 3 kredity jako každé jiné spuštění. Najdete ho přes Výpis spuštění.
/automations/{id}/triggerParametry v cestě
idstringpovinnéaut_…).Parametry v těle požadavku
payloadobjectData pro spuštění. Emailit přidá automation_id a výsledek uloží jako payload spuštění. Kroky ho mohou číst přes proměnné, například {{payload.order_id}}, a přes podmínky, například payload.plan.
Čeho se spuštění týká, závisí na kontextu automatizace:
contact: předejtecontact_id(con_…). Akce s kontakty asend_emailpoužijí tento kontakt.email: předejteemail_id(em_…). Akce s e-maily použijí tento e-mail.event: libovolná data. V konfiguraci akcí nastavtetoneboemail, například"to": "{{payload.customer_email}}".
Odpověď
Jakmile se aktivace spouštěče zařadí do fronty, vrací 200 s polem message. Pokud automatizace není ve stavu running, vrací 422, a pokud neexistuje, 404.
{
"message": "Automation trigger dispatched."
}{
"message": "Automation must be running to trigger."
}{
"message": "Automation not found."
}Výpis spuštění
Vrátí spuštění automatizace od nejnovějších. Každé spuštění je jeden průchod grafem, který zahájil spouštěč. Vyžaduje API klíč s oprávněním full.
/automations/{id}/runsParametry v cestě
idstringpovinnéaut_…).Parametry dotazu
pageintegervýchozí: 1per_pageintegervýchozí: 25filter[status]stringrunning, completed, failed nebo canceled.filter[contact_id]stringcon_…). Spuštění kontaktu ve všech automatizacích najdete přes Výpis spuštění kontaktu.Filtrovat můžete také přes key.condition=value podle status, event a created_at (například created_at.after=2026-10-01) a podle stejných klíčů řadit přes order a direction. Viz Filtrování.
Odpověď
dataobject[]total_records, per_page, current_page, total_pagesintegerKaždé spuštění má:
idstringaur_.automation_idstringaut_…).contact_idstring | nullcon_…) v kontextu contact.email_idstring | nullem_…) v kontextu email.event_idstring | nulleventstringcontact.added_to_audience nebo system.manual.payloadobjectmetaobjectfailure_reason, načtěte spuštění.statusstringrunning, completed, failed nebo canceled.cancel_reasonstring | nullexit_condition, left_audience, canceled_by_user (nebo reason, který jste poslali), exited_by_api, exited_by_automation, automation_stopped nebo contact_deleted.started_at, completed_at, created_at, updated_atstring | null{
"data": [
{
"id": "aur_3q6GdFk2eRSG093grI0v9e6REu8",
"automation_id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"contact_id": "con_3munwNLaXKUARc6ff9wPtxKVq4A",
"email_id": null,
"event_id": null,
"event": "contact.added_to_audience",
"payload": {},
"meta": {},
"status": "failed",
"started_at": "2026-10-03T14:12:40.551870+00:00",
"completed_at": "2026-10-03T14:12:41.093355+00:00",
"created_at": "2026-10-03T14:12:40.551870+00:00",
"updated_at": "2026-10-03T14:12:41.093355+00:00"
}
],
"total_records": 1,
"per_page": 25,
"current_page": 1,
"total_pages": 1
}{
"message": "Automation not found."
}Načtení spuštění
Načte jedno spuštění automatizace včetně provedených kroků. Vyžaduje API klíč s oprávněním full.
/automations/{id}/runs/{run_id}Parametry v cestě
idstringpovinnéaut_…).run_idstringpovinnéaur_…).Odpověď
Vrací spuštění v poli data s poli popsanými na stránce Výpis spuštění a navíc s úplnými payload a meta, polem run_steps a polem waits.
payloadobject | null{ "object": { … } }), nebo obsah, který jste předali při ručním spuštění, s přidaným automation_id.metaobject | nullsource_event_id propojuje spuštění s událostí, která ho zahájila. Neúspěšná spuštění mohou mít failure_reason: insufficient_credits (3 kredity za spuštění nebylo možné naúčtovat), nebo run_timeout (spuštění bylo po 72 hodinách stále ve stavu running, aniž by čekalo na některém kroku). Zrušená spuštění mají cancel_reason a dokončená spuštění, která skončila předčasně, mají ended_by, například end_run_step, moved_to_automation nebo goal_not_met. Spuštění zahájená jinou automatizací mají depth a buď parent_run_id (zahájená krokem Start automation), nebo caused_by (zahájená změnou, kterou provedl krok).run_stepsobject[]Jedna položka za každý krok, ke kterému spuštění došlo:
step_id: ID kroku (aus_…) a k tomustep_keyaaction, tedy klíč a akce kroku.status:running,waiting(krokwaitnebowait_until, který ještě neskončil),completed,failed,skipped(přeskočený, když spuštění přeskočilo k cíli nebo skončilo předčasně) nebocanceled.outcome: výsledek, například poslední stav e-mailu odeslaného krokemsend_email(delivered,loaded,clicked…),skippedu marketingového e-mailu pro odhlášený kontakt,matched, nebonot_matchedu podmínky,matched, nebotimeoutuwait_untilareached, nebonot_reachedu cíle.data: výsledek kroku. Napříkladsend_emailvrací{ "result": "email_queued", "email_oid": "em_…", "to": "…" },conditionvrací{ "result": true, "branch": "yes" }a neúspěšné kroky vracejí{ "error": "…" }.started_at,completed_at,created_at.
waitsobject[]Čekání spuštění v krocích wait_until (na událost nebo podmínku) a goal: id, step_key, kind (event, nebo condition), event, status (waiting, matched, timed_out nebo canceled), timeout_at, created_at a resolved_at.
Pokud automatizace nebo spuštění neexistuje, vrací 404.
{
"data": {
"id": "aur_3q6GdFk2eRSG093grI0v9e6REu8",
"automation_id": "aut_3xqC9YD79FZZA36uTekWTBO1ghe",
"contact_id": "con_3munwNLaXKUARc6ff9wPtxKVq4A",
"email_id": null,
"event_id": null,
"event": "contact.added_to_audience",
"payload": {
"object": {
"id": "sub_3Fh2pQx9LmZr4Wt7Nc0bVd8KsYe",
"object": "subscriber",
"subscribed": true,
"audience": { "id": "aud_3Cz7WJ9GpvD7P0PQez50xOmkZSV", "name": "Newsletter" },
"contact": { "id": "con_3munwNLaXKUARc6ff9wPtxKVq4A", "email": "ada@example.com" }
}
},
"meta": { "source_event_id": "evt_3Kd8sWq1NzXc5Vb7Mt2LpRy0HgA" },
"status": "running",
"started_at": "2026-10-03T14:12:40.551870+00:00",
"completed_at": null,
"created_at": "2026-10-03T14:12:40.551870+00:00",
"updated_at": "2026-10-03T14:12:40.551870+00:00",
"run_steps": [
{
"step_id": "aus_3V5TZIXXak1SSmGcOmzPOeFaguQ",
"status": "completed",
"data": {
"result": "email_queued",
"outcome": "accepted",
"email_oid": "em_3Cp8cMgPskzB8tIlgUyNJkpDp9O",
"to": "ada@example.com"
},
"started_at": "2026-10-03T14:12:40.702113+00:00",
"completed_at": "2026-10-03T14:12:40.918540+00:00",
"created_at": "2026-10-03T14:12:40.702113+00:00"
},
{
"step_id": "aus_3vM0ORwEXCQcyS7rylfQBQEXjVk",
"status": "waiting",
"data": { "status": "waiting", "delayMs": 86400000, "seconds": 86400 },
"started_at": "2026-10-03T14:12:41.004221+00:00",
"completed_at": null,
"created_at": "2026-10-03T14:12:41.004221+00:00"
}
]
}
}{
"message": "Run not found."
}Zrušení spuštění
Zruší spuštění, které je ještě ve stavu running. Kroky čekající v Time delay nebo Wait until se zruší, žádné další kroky se neprovedou a spuštění přejde do stavu canceled. Vyžaduje API klíč s oprávněním full.
Zrušená spuštění nelze obnovit. Pokud chcete zrušit všechna spuštění jednoho kontaktu v automatizaci, použijte Odebrání kontaktu z automatizace. Pokud chcete spuštění rušit automaticky, použijte podmínky ukončení.
/automations/{id}/runs/{run_id}/cancelParametry v cestě
idstringpovinnéaut_…).run_idstringpovinnéaur_…).Parametry v těle požadavku
reasonstringvýchozí: canceled_by_usercancel_reason spuštění, nejvýše 200 znaků.Odpověď
Vrací spuštění v data se status canceled a s cancel_reason. Pokud automatizace nebo spuštění neexistuje, vrací 404, a pokud spuštění neprobíhá, 422.
Odebrání kontaktu z automatizace
Zruší všechna spuštění této automatizace, která jsou pro jeden kontakt ještě ve stavu running, například z vašeho e-shopu, když je objednávka zaplacená. Spuštění dostanou stav canceled. Vyžaduje API klíč s oprávněním full.
Pokud chcete kontakty vyřazovat automaticky, když se něco stane, použijte místo toho podmínky ukončení.
/automations/{id}/exitParametry v cestě
idstringpovinnéaut_…).Parametry v těle požadavku
contact_idstringcon_…). Pošlete tento parametr, nebo email.emailstringreasonstringvýchozí: exited_by_apicancel_reason každého spuštění, nejvýše 200 znaků.Odpověď
dataobjectautomation_id, contact_id a canceled_runs, tedy ID zrušených spuštění. Prázdné, pokud kontakt žádná probíhající spuštění neměl.messagestringCanceled 1 run.Bez contact_id nebo email vrací 400, pro neexistující automatizaci nebo kontakt 404.
Výpis spuštění kontaktu
Vrátí posledních 100 spuštění jednoho kontaktu ve všech automatizacích, od nejnovějšího, každé s názvem automatizace. Vyžaduje API klíč s oprávněním full.
/automations/runsParametry dotazu
contact_idstringcon_…). Pošlete tento parametr, nebo email.emailstringstatusstringrunning, completed, failed nebo canceled.Odpověď
dataobject[]automation_name.Bez contact_id nebo email vrací 400, pro neexistující kontakt 404.
Načtení statistik
Vrátí počty pro všechny kroky automatizace, s klíči podle klíčů kroků. Vyžaduje API klíč s oprávněním full.
/automations/{id}/statsParametry v cestě
idstringpovinnéaut_…).Parametry dotazu
sincestring2026-10-01T00:00:00Z.untilstringrun_ids[]stringaur_…). Pro více spuštění parametr zopakujte.Odpověď
Vrací data, objekt s jednou položkou pro každý klíč kroku. Kroky, ke kterým nedošlo žádné spuštění, mají total rovné 0.
totalintegerby_statusobjectrunning, waiting, completed, failed.by_outcomeobjectsend_email a forward_email: accepted a pak poslední stav e-mailu (delivered, loaded, clicked, bounced, failed, complained, unsubscribed, canceled). condition: matched, not_matched. experiment: klíč vybrané varianty. call_webhook: 2xx, 4xx, 5xx, timeout, network_error. Neúspěšné kroky: error.funnelobjectsend_email. Kumulativní počty: accepted zahrnuje každý e-mail, který se dostal dál, delivered zahrnuje načtené a prokliknuté e-maily a loaded zahrnuje prokliknuté. bounced, failed, complained a unsubscribed jsou prosté počty.{
"data": {
"joined": { "total": 0, "by_status": {}, "by_outcome": {} },
"welcome_email": {
"total": 412,
"by_status": { "completed": 409, "failed": 3 },
"by_outcome": { "delivered": 251, "loaded": 98, "clicked": 41, "bounced": 19, "error": 3 },
"funnel": {
"accepted": 390,
"delivered": 390,
"loaded": 139,
"clicked": 41,
"bounced": 19,
"failed": 0,
"complained": 0,
"unsubscribed": 0
}
},
"wait_1_day": {
"total": 409,
"by_status": { "completed": 352, "waiting": 57 },
"by_outcome": {}
},
"is_free_user": {
"total": 352,
"by_status": { "completed": 352 },
"by_outcome": { "matched": 270, "not_matched": 82 }
},
"upgrade_tips": {
"total": 270,
"by_status": { "completed": 270 },
"by_outcome": { "accepted": 12, "delivered": 180, "loaded": 61, "clicked": 17 },
"funnel": {
"accepted": 270,
"delivered": 258,
"loaded": 78,
"clicked": 17,
"bounced": 0,
"failed": 0,
"complained": 0,
"unsubscribed": 0
}
},
"done": {
"total": 82,
"by_status": { "completed": 82 },
"by_outcome": {}
}
}
}{
"message": "Automation not found."
}Načtení statistik kroků
Vrátí počty pro jeden krok automatizace. Vyžaduje API klíč s oprávněním full. Pole jsou stejná jako na stránce Načtení statistik.
/automations/{id}/steps/{step_key}/statsParametry v cestě
idstringpovinnéaut_…).step_keystringpovinnékey kroku, například welcome_email.Parametry dotazu
sincestringuntilstringOdpověď
Vrací data s poli total, by_status, by_outcome a u kroků send_email také funnel. Pokud automatizace nebo klíč kroku neexistuje, vrací 404.
{
"data": {
"total": 412,
"by_status": { "completed": 409, "failed": 3 },
"by_outcome": { "delivered": 251, "loaded": 98, "clicked": 41, "bounced": 19, "error": 3 },
"funnel": {
"accepted": 390,
"delivered": 390,
"loaded": 139,
"clicked": 41,
"bounced": 19,
"failed": 0,
"complained": 0,
"unsubscribed": 0
}
}
}{
"message": "Step not found."
}