Statistics

E-mail statistics of campaigns and automations, dashboard, conversions.

Technická referencia je v angličtine (rovnako ako strojovo čitateľný dokument OpenAPI). Celú skupinu pre AI agenta načítate z /api/openapi.json?tag=Statistics.

Prihlásenie: Authorization: Bearer pst_... alebo HTTP Basic (e-mail člena firmy a API kľúč).

Operácie

Metóda	Cesta	Popis
GET	`/api/v1/tenants/{tenant}/conversions`	Conversions summary
GET	`/api/v1/tenants/{tenant}/dashboard`	Dashboard numbers
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}`	Statistics of an automation
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}/activity`	Activity of an automation over time
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}/conversions`	Conversions (orders) of an automation
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}/heatmap`	Click map of an automation
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}/recipients`	Recipients of an automation with their events (JSON or CSV)
GET	`/api/v1/tenants/{tenant}/stats/automations/{automation_id}/report`	Report of an automation (JSON or CSV)
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}`	Statistics of a campaign
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/activity`	Activity of a campaign over time
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/conversions`	Conversions (orders) of a campaign
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/heatmap`	Click map of a campaign
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/recipients`	Recipients of a campaign with their events (JSON or CSV)
GET	`/api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/report`	Report of a campaign (JSON or CSV)
GET	`/api/v1/tenants/{tenant}/stats/emails`	E-mail statistics of campaigns and automations

Conversions summary

GET /api/v1/tenants/{tenant}/conversions

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Conversions per kind and currency, optionally of one campaign or automation and in [from, to).

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automationId`	query	string	nie
`campaignId`	query	string	nie
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).

Odpovede

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Dashboard numbers

GET /api/v1/tenants/{tenant}/dashboard

Oprávnenie: modul null, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_dashboard

Dashboard: contacts (total, subscribed, added and lost in 30 days, daily trend) and e-mails of the last 30 days against the 30 days before.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovede

200 OK: application/json DashboardData

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Statistics of an automation

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_automation_stats

E-mail statistics of an automation (or of one e-mail node).

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`from`	query	string	nie	First day YYYY-MM-DD.
`node`	query	string	nie	E-mail node key.
`to`	query	string	nie	Last day YYYY-MM-DD.

Odpovede

200 OK: application/json EmailStatsDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	node, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Activity of an automation over time

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}/activity

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`node`	query	string	nie
`page`	query	integer	nie	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	nie	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	nie	Search text (case and diacritics insensitive). max 200 chars
`tab`	query	string	nie
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).

Odpovede

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	node, q, tab, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Conversions (orders) of an automation

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}/conversions

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`node`	query	string	nie

Odpovede

200 OK: application/json EmailConversions

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	node, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Click map of an automation

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}/heatmap

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

The same for one e-mail node of an automation (?node=, the template of the node); without a node no HTML.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`node`	query	string	nie

Odpovede

200 OK: application/json EmailHeatmap

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	node, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Recipients of an automation with their events (JSON or CSV)

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}/recipients

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`engagement`	query	string	nie
`format`	query	one of: `json`, `csv`	nie	csv = a CSV file (UTF-8 with BOM, semicolons).
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`humans`	query	string	nie
`node`	query	string	nie
`page`	query	integer	nie	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	nie	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	nie	Search text (case and diacritics insensitive). max 200 chars
`rows`	query	string	nie
`tab`	query	string	nie
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).
`vat`	query	string	nie

Odpovede

200 JSON, or CSV with format=csv: application/json object, text/csv string

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	engagement, node, q, tab, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Report of an automation (JSON or CSV)

GET /api/v1/tenants/{tenant}/stats/automations/{automation_id}/report

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Poznámky kontraktu (cs): Detail jako SE (core/stats_report.py), filtry ?engagement=A,B,… (skupiny angažovanosti, prázdné = všechny), ?humans=1 (bez otevření přes proxy obrázků webmailu), ?vat=1 (peníze s DPH, jinak bez), u automatizace ?node=. 400 validation / engagement, humans, vat. EmailStatsReport: hlavička (name, status, startedAt, completedAt, shopId, nodes), filters, firstSentAt, lastSentAt, totals (EmailMetrics + orders, orderRate, reopeners, reopenRate), baseline (poměry e-mailů účtu za 30 dní před kampaní, u automatizace před dneškem; sent = průměrná velikost jednorázové kampaně; null bez dat), days (po dnech od prvního e-mailu, nejvýš 31: unikátní otevření, prokliky, odhlášení, vrácení), domains (sent, opened, clicked, unsubscribed, bounced, buyers; {name, count}, name '' = zbytek), clients a systems (opened, clicked), links (url, clicks, uniqueClicks, share), unsubscribeReasons (too_often, not_relevant, annoying, not_signed_up, spam_report, other, custom, none, misc), bounceReasons (mailbox_full, spam_filter, no_address, transfer_error, temporary, server_error, mx_error, greylisted, suppressed, other), bounceSplit, revenue (po měnách: objednávky, přímé a asistované, průměr, obrat e-shopu stejné měny od prvního e-mailu do 5 dní po posledním a podíl), revenueDays, conversionLinks, products (prodané kusy s obrázkem), engagementSpend, topSpenders. CZK a EUR nikdy dohromady.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automation_id`	path	string	áno	Id of the automation (string of digits).
`engagement`	query	string	nie
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`humans`	query	string	nie
`node`	query	string	nie
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).
`vat`	query	string	nie

Odpovede

200 OK: application/json EmailStatsReport

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	engagement, node, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Statistics of a campaign

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_campaign_stats

E-mail statistics of a campaign: totals, rates (base: sent), providers, daily timeline, links.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`from`	query	string	nie	First day YYYY-MM-DD.
`node`	query	string	nie
`to`	query	string	nie	Last day YYYY-MM-DD.

Odpovede

200 OK: application/json EmailStatsDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Activity of a campaign over time

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/activity

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_campaign_activity

Who opened, clicked, unsubscribed or bounced (tab).

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`from`	query	string	nie	First day YYYY-MM-DD.
`node`	query	string	nie
`page`	query	integer	nie	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	nie	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	nie	Search text. max 200 chars
`tab`	query	one of: `opened`, `clicked`, `unsubscribed`, `bounced`	nie	Tab.
`to`	query	string	nie	Last day YYYY-MM-DD.

Odpovede

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	q, tab, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Conversions (orders) of a campaign

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/conversions

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_campaign_conversions

Orders after clicks of the campaign (direct within 24 hours, assisted), per currency.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`node`	query	string	nie

Odpovede

200 OK: application/json EmailConversions

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Click map of a campaign

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/heatmap

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

SE "Heatmapa prokliků": the campaign's HTML (merge tags unfilled, the UI shows it in a sandboxed frame without scripts) and the clicks per link of its e-mails.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`node`	query	string	nie

Odpovede

200 OK: application/json EmailHeatmap

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Recipients of a campaign with their events (JSON or CSV)

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/recipients

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`engagement`	query	string	nie
`format`	query	one of: `json`, `csv`	nie	csv = a CSV file (UTF-8 with BOM, semicolons).
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`humans`	query	string	nie
`node`	query	string	nie
`page`	query	integer	nie	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	nie	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	nie	Search text (case and diacritics insensitive). max 200 chars
`rows`	query	string	nie
`tab`	query	string	nie
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).
`vat`	query	string	nie

Odpovede

200 JSON, or CSV with format=csv: application/json object, text/csv string

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	engagement, q, tab, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Report of a campaign (JSON or CSV)

GET /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/report

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`campaign_id`	path	string	áno	Id of the campaign (string of digits).
`engagement`	query	string	nie
`from`	query	string	nie	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`humans`	query	string	nie
`node`	query	string	nie
`to`	query	string	nie	End of the period (YYYY-MM-DD local day, or ISO time where noted).
`vat`	query	string	nie

Odpovede

200 OK: application/json EmailStatsReport

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	engagement, to
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

E-mail statistics of campaigns and automations

GET /api/v1/tenants/{tenant}/stats/emails

Oprávnenie: modul campaigns, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_email_stats

Sent campaigns and automation e-mails with their metrics, newest first.

Parametre

Názov	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	áno	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`automationIds`	query	string	nie
`kind`	query	one of: `campaign`, `automation`	nie	campaign or automation.
`name`	query	string	nie
`page`	query	integer	nie	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	nie	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	nie	Search text. max 200 chars
`ref`	query	string	nie
`shop`	query	string	nie	Shop id filter.
`sort`	query	string	nie	Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).
`tag`	query	string	nie	Label filter; repeat for more labels.

Odpovede

200 OK: application/json EmailStatsPage

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	automationIds, countTo, kind, name, q, sentTo, sort
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Schémy

ConversionCurrency

One currency: CZK and EUR are never added up or converted.

Pole	Typ	Povinné
`currency`	Currency	áno
`direct`	ConversionPart	áno
`assisted`	ConversionPart	áno

ConversionOrder

Pole	Typ	Povinné
`orderId`	string	áno
`code`	string	áno
`contactId`	string or null	áno
`email`	string or null	áno
`kind`	one of: `direct`, `assisted`	áno
`clickedAt`	string	áno
`orderedAt`	string	áno
`currency`	Currency	áno
`totalWithVat`	string or null	áno
`totalWithoutVat`	string or null	áno

ConversionPart

Pole	Typ	Povinné
`orders`	number	áno
`revenue`	string or null	áno
`revenueWithoutVat`	string or null	áno

Currency

one of: CZK, EUR

DashboardData

Pole	Typ	Povinné	Popis
`days`	number	áno
`contacts`	object or null	áno	null when the member's roles cannot read contacts.
`lastContact`	object or null	áno
`emails`	object or null	áno	null when the member's roles cannot read campaigns.
`lastEmail`	object or null	áno

EmailConversions

Pole	Typ	Povinné	Popis
`available`	boolean	áno	false = no conversion provider yet (the tab says so instead of showing zeros).
`directHours`	number	áno
`assistedDays`	number	áno
`currencies`	array of ConversionCurrency	áno
`orders`	array of ConversionOrder	áno

EmailHeatmap

SE "Heatmapa prokliků": the e-mail's HTML and the clicks of every link.

Pole	Typ	Povinné	Popis
`html`	string	áno
`links`	array of object	áno

EmailMetrics

Counts of e-mails and their events (server core/stats.py). Rates as SmartEmailing: openRate, unsubscribeRate and complaintRate over the delivered e-mails, ctr and bounceRate over the sent ones; ctor = unique clicks / unique opens. Test e-mails never count.

Pole	Typ	Povinné	Popis
`sent`	number	áno
`delivered`	number	áno	sent - undelivered
`undelivered`	number	áno	Hard or soft bounce (SE "Nedoručeno").
`bounced`	number	áno
`softBounced`	number	áno
`opens`	number	áno
`uniqueOpens`	number	áno
`repeatedOpens`	number	áno
`machineOpens`	number	áno	E-mails whose pixel only a machine fetched (Apple Mail Privacy Protection, security gateways): whether a person read them is unknown, so they are in no open count or rate.
`clicks`	number	áno
`uniqueClicks`	number	áno
`unsubscribed`	number	áno
`complained`	number	áno
`queued`	number	áno
`failed`	number	áno
`skipped`	number	áno
`openRate`	number	áno
`ctr`	number	áno
`ctor`	number	áno
`unsubscribeRate`	number	áno
`bounceRate`	number	áno
`complaintRate`	number	áno
`deliveryRate`	number	áno	delivered / sent

EmailStatsDetail

Pole	Typ	Povinné
`kind`	one of: `campaign`, `automation`	áno
`campaignId`	string or null	áno
`automationId`	string or null	áno
`nodeKey`	string or null	áno
`name`	string	áno
`subject`	string	áno
`shopId`	string	áno
`status`	string	áno
`sentAt`	string or null	áno
`nodes`	array of object	áno
`totals`	EmailMetrics	áno
`providers`	array of object	áno
`timeline`	array of StatsDay	áno
`links`	array of object	áno

EmailStatsItem

Pole	Typ	Povinné	Popis
`id`	string	áno	c<campaign id> or a<automation id>:<node key>
`kind`	one of: `campaign`, `automation`	áno
`campaignId`	string or null	áno
`automationId`	string or null	áno
`nodeKey`	string or null	áno
`name`	string	áno
`nodeName`	string	áno
`subject`	string	áno
`shopId`	string	áno
`status`	string	áno
`sentAt`	string or null	áno
`stats`	EmailMetrics	áno

EmailStatsPage

A page of the statistics grid; totals = every e-mail of the asked automations together (query.automationIds).

Pole	Typ	Povinné
`items`	array of EmailStatsItem	áno
`total`	number	áno
`page`	number	áno
`pageSize`	number	áno
`totals`	EmailMetrics	nie

EmailStatsReport

Pole	Typ	Povinné	Popis
`kind`	one of: `campaign`, `automation`	áno
`campaignId`	string or null	áno
`automationId`	string or null	áno
`nodeKey`	string or null	áno
`name`	string	áno
`status`	string	áno
`startedAt`	string or null	áno
`completedAt`	string or null	áno
`shopId`	string	áno
`nodes`	array of object	áno
`filters`	object	áno
`firstSentAt`	string or null	áno
`lastSentAt`	string or null	áno
`totals`	ReportMetrics	áno
`baseline`	ReportBaseline or null	áno
`days`	array of ReportDay	áno
`domains`	object	áno
`clients`	object	áno
`systems`	object	áno
`links`	array of object	áno
`unsubscribeReasons`	array of object	áno
`bounceReasons`	array of object	áno
`bounceSplit`	object	áno
`revenue`	array of ReportRevenue	áno
`revenueDays`	array of object	áno
`conversionLinks`	array of NamedCount	áno	Orders per clicked link (SE "Nejúspěšnější odkazy").
`products`	array of object	áno	Items sold (quantity) with a picture.
`engagementSpend`	array of object	áno
`topSpenders`	array of object	áno

Error

Pole	Typ	Povinné	Popis
`error`	object	áno

json

{
  "error": {
    "code": "validation",
    "message": "email"
  }
}

NamedCount

Pole	Typ	Povinné	Popis
`name`	string	áno	'' = the rest (SE "Ostatní").
`count`	number	áno

ReportBaseline

The account's e-mails of the 30 days before (trend "oproti předchozím 30 dnům"); sent = average one-time campaign.

Pole	Typ	Povinné
`sent`	number or null	áno
`openRate`	number	áno
`ctr`	number	áno
`ctor`	number	áno
`complaintRate`	number	áno
`unsubscribeRate`	number	áno
`bounceRate`	number	áno
`deliveryRate`	number	áno
`orderRate`	number	áno

ReportDay

Pole	Typ	Povinné
`date`	string	áno
`opens`	number	áno
`clicks`	number	áno
`unsubscribed`	number	áno
`bounced`	number	áno

ReportMetrics

Rates as SE computes them: openRate, unsubscribeRate and complaintRate over delivered, ctr and orderRate over sent.

Pole	Typ	Povinné	Popis
`orders`	number	áno
`orderRate`	number	áno
`reopeners`	number	áno	E-mails opened more than once, and their share of the opened ones (SE "Opakovaná otevření").
`reopenRate`	number	áno
`webVersionViews`	number	áno	SE's Online verze and Tisk (ST-04): views of the web version and prints, the e-mails with one, and their share of the opened e-mails.
`webVersionUnique`	number	áno
`webVersionRate`	number	áno
`printViews`	number	áno
`printUnique`	number	áno
`printRate`	number	áno
`sent`	number	áno
`delivered`	number	áno	sent - undelivered
`undelivered`	number	áno	Hard or soft bounce (SE "Nedoručeno").
`bounced`	number	áno
`softBounced`	number	áno
`opens`	number	áno
`uniqueOpens`	number	áno
`repeatedOpens`	number	áno
`machineOpens`	number	áno	E-mails whose pixel only a machine fetched (Apple Mail Privacy Protection, security gateways): whether a person read them is unknown, so they are in no open count or rate.
`clicks`	number	áno
`uniqueClicks`	number	áno
`unsubscribed`	number	áno
`complained`	number	áno
`queued`	number	áno
`failed`	number	áno
`skipped`	number	áno
`openRate`	number	áno
`ctr`	number	áno
`ctor`	number	áno
`unsubscribeRate`	number	áno
`bounceRate`	number	áno
`complaintRate`	number	áno
`deliveryRate`	number	áno	delivered / sent

ReportRevenue

Pole	Typ	Povinné	Popis
`currency`	Currency	áno
`orders`	number	áno
`directOrders`	number	áno
`assistedOrders`	number	áno
`total`	string	áno
`direct`	string	áno
`assisted`	string	áno
`averageOrder`	string	áno
`directAverage`	string	áno
`assistedAverage`	string	áno
`eshopOrders`	number	áno
`eshopTotal`	string	áno
`share`	number	áno
`margin`	string or null	nie	SE's Marže and Průměrná marže without VAT (ST-03): from the purchase prices the e-shop sent with the order lines; null when no order of the group has one. *MarginOrders = orders with a known margin.
`marginAverage`	string or null	nie
`marginOrders`	number	nie
`directMargin`	string or null	nie
`directMarginAverage`	string or null	nie
`directMarginOrders`	number	nie
`assistedMargin`	string or null	nie
`assistedMarginAverage`	string or null	nie
`assistedMarginOrders`	number	nie

StatsActivity

Pole	Typ	Povinné
`sendId`	string	áno
`contactId`	string or null	áno
`email`	string	áno
`firstAt`	string	áno
`lastAt`	string	áno
`opens`	number	áno
`clicks`	number	áno
`type`	StatsActivityType	áno
`source`	string	áno
`links`	array of string	áno
`detail`	string	áno

StatsActivityType

one of: complaint, unsubscribe, open, click, hard, soft

StatsDay

Pole	Typ	Povinné
`date`	string	áno
`opens`	number	áno
`clicks`	number	áno
`unsubscribed`	number	áno

Statistics

Operácie#

Conversions summary#

Dashboard numbers#

Statistics of an automation#

Activity of an automation over time#

Conversions (orders) of an automation#

Click map of an automation#

Recipients of an automation with their events (JSON or CSV)#

Report of an automation (JSON or CSV)#

Statistics of a campaign#

Activity of a campaign over time#

Conversions (orders) of a campaign#

Click map of a campaign#

Recipients of a campaign with their events (JSON or CSV)#

Report of a campaign (JSON or CSV)#

E-mail statistics of campaigns and automations#

Schémy#

ConversionCurrency#

ConversionOrder#

ConversionPart#

Currency#

DashboardData#

EmailConversions#

EmailHeatmap#

EmailMetrics#

EmailStatsDetail#

EmailStatsItem#

EmailStatsPage#

EmailStatsReport#

Error#

NamedCount#

ReportBaseline#

ReportDay#

ReportMetrics#

ReportRevenue#

StatsActivity#

StatsActivityType#

StatsDay#

Operácie

Conversions summary

Dashboard numbers

Statistics of an automation

Activity of an automation over time

Conversions (orders) of an automation

Click map of an automation

Recipients of an automation with their events (JSON or CSV)

Report of an automation (JSON or CSV)

Statistics of a campaign

Activity of a campaign over time

Conversions (orders) of a campaign

Click map of a campaign

Recipients of a campaign with their events (JSON or CSV)

Report of a campaign (JSON or CSV)

E-mail statistics of campaigns and automations

Schémy

ConversionCurrency

ConversionOrder

ConversionPart

Currency

DashboardData

EmailConversions

EmailHeatmap

EmailMetrics

EmailStatsDetail

EmailStatsItem

EmailStatsPage

EmailStatsReport

Error

NamedCount

ReportBaseline

ReportDay

ReportMetrics

ReportRevenue

StatsActivity

StatsActivityType

StatsDay