Statistics
E-mail statistics of campaigns and automations, dashboard, conversions.
Technická reference je anglicky (stejně jako strojově čitelný dokument OpenAPI). Celou skupinu pro AI agenta načtete z /api/openapi.json?tag=Statistics.
Přihlášení: Authorization: Bearer pst_... nebo HTTP Basic (e-mail člena firmy a API klíč).
Operace
| Metoda | 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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Conversions per kind and currency, optionally of one campaign or automation and in [from, to).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ne | |
campaignId | query | string | ne | |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
Odpovědi
- 200 OK:
application/jsonobject
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ávnění: modul null, úroveň read; klíč s přístupem read nebo 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.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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. |
Odpovědi
- 200 OK:
application/jsonDashboardData
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_automation_stats
E-mail statistics of an automation (or of one e-mail node).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
from | query | string | ne | First day YYYY-MM-DD. |
node | query | string | ne | E-mail node key. |
to | query | string | ne | Last day YYYY-MM-DD. |
Odpovědi
- 200 OK:
application/jsonEmailStatsDetail
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
node | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
tab | query | string | ne | |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
Odpovědi
- 200 OK:
application/jsonobject
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
node | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailConversions
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
The same for one e-mail node of an automation (?node=, the template of the node); without a node no HTML.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
node | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailHeatmap
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
engagement | query | string | ne | |
format | query | one of: json, csv | ne | csv = a CSV file (UTF-8 with BOM, semicolons). |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
humans | query | string | ne | |
node | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
rows | query | string | ne | |
tab | query | string | ne | |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
vat | query | string | ne |
Odpovědi
- 200 JSON, or CSV with format=csv:
application/jsonobject,text/csvstring
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the automation (string of digits). |
engagement | query | string | ne | |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
humans | query | string | ne | |
node | query | string | ne | |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
vat | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailStatsReport
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_campaign_stats
E-mail statistics of a campaign: totals, rates (base: sent), providers, daily timeline, links.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
from | query | string | ne | First day YYYY-MM-DD. |
node | query | string | ne | |
to | query | string | ne | Last day YYYY-MM-DD. |
Odpovědi
- 200 OK:
application/jsonEmailStatsDetail
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_campaign_activity
Who opened, clicked, unsubscribed or bounced (tab).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
from | query | string | ne | First day YYYY-MM-DD. |
node | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text. max 200 chars |
tab | query | one of: opened, clicked, unsubscribed, bounced | ne | Tab. |
to | query | string | ne | Last day YYYY-MM-DD. |
Odpovědi
- 200 OK:
application/jsonobject
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_campaign_conversions
Orders after clicks of the campaign (direct within 24 hours, assisted), per currency.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
node | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailConversions
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo 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.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
node | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailHeatmap
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
engagement | query | string | ne | |
format | query | one of: json, csv | ne | csv = a CSV file (UTF-8 with BOM, semicolons). |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
humans | query | string | ne | |
node | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
rows | query | string | ne | |
tab | query | string | ne | |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
vat | query | string | ne |
Odpovědi
- 200 JSON, or CSV with format=csv:
application/jsonobject,text/csvstring
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ano | Id of the campaign (string of digits). |
engagement | query | string | ne | |
from | query | string | ne | Start of the period (YYYY-MM-DD local day, or ISO time where noted). |
humans | query | string | ne | |
node | query | string | ne | |
to | query | string | ne | End of the period (YYYY-MM-DD local day, or ISO time where noted). |
vat | query | string | ne |
Odpovědi
- 200 OK:
application/jsonEmailStatsReport
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ávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_email_stats
Sent campaigns and automation e-mails with their metrics, newest first.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | 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 | ne | |
kind | query | one of: campaign, automation | ne | campaign or automation. |
name | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text. max 200 chars |
ref | query | string | ne | |
shop | query | string | ne | Shop id filter. |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
tag | query | string | ne | Label filter; repeat for more labels. |
Odpovědi
- 200 OK:
application/jsonEmailStatsPage
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émata
ConversionCurrency
One currency: CZK and EUR are never added up or converted.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
currency | Currency | ano | |
direct | ConversionPart | ano | |
assisted | ConversionPart | ano |
ConversionOrder
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
orderId | string | ano | |
code | string | ano | |
contactId | string or null | ano | |
email | string or null | ano | |
kind | one of: direct, assisted | ano | |
clickedAt | string | ano | |
orderedAt | string | ano | |
currency | Currency | ano | |
totalWithVat | string or null | ano | |
totalWithoutVat | string or null | ano |
ConversionPart
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
orders | number | ano | |
revenue | string or null | ano | |
revenueWithoutVat | string or null | ano |
Currency
one of: CZK, EUR
DashboardData
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
days | number | ano | |
contacts | object or null | ano | null when the member's roles cannot read contacts. |
lastContact | object or null | ano | |
emails | object or null | ano | null when the member's roles cannot read campaigns. |
lastEmail | object or null | ano |
EmailConversions
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
available | boolean | ano | false = no conversion provider yet (the tab says so instead of showing zeros). |
directHours | number | ano | |
assistedDays | number | ano | |
currencies | array of ConversionCurrency | ano | |
orders | array of ConversionOrder | ano |
EmailHeatmap
SE "Heatmapa prokliků": the e-mail's HTML and the clicks of every link.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
html | string | ano | |
links | array of object | ano |
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 | ano | |
delivered | number | ano | sent - undelivered |
undelivered | number | ano | Hard or soft bounce (SE "Nedoručeno"). |
bounced | number | ano | |
softBounced | number | ano | |
opens | number | ano | |
uniqueOpens | number | ano | |
repeatedOpens | number | ano | |
machineOpens | number | ano | 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 | ano | |
uniqueClicks | number | ano | |
unsubscribed | number | ano | |
complained | number | ano | |
queued | number | ano | |
failed | number | ano | |
skipped | number | ano | |
openRate | number | ano | |
ctr | number | ano | |
ctor | number | ano | |
unsubscribeRate | number | ano | |
bounceRate | number | ano | |
complaintRate | number | ano | |
deliveryRate | number | ano | delivered / sent |
EmailStatsDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
kind | one of: campaign, automation | ano | |
campaignId | string or null | ano | |
automationId | string or null | ano | |
nodeKey | string or null | ano | |
name | string | ano | |
subject | string | ano | |
shopId | string | ano | |
status | string | ano | |
sentAt | string or null | ano | |
nodes | array of object | ano | |
totals | EmailMetrics | ano | |
providers | array of object | ano | |
timeline | array of StatsDay | ano | |
links | array of object | ano |
EmailStatsItem
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | c<campaign id> or a<automation id>:<node key> |
kind | one of: campaign, automation | ano | |
campaignId | string or null | ano | |
automationId | string or null | ano | |
nodeKey | string or null | ano | |
name | string | ano | |
nodeName | string | ano | |
subject | string | ano | |
shopId | string | ano | |
status | string | ano | |
sentAt | string or null | ano | |
stats | EmailMetrics | ano |
EmailStatsPage
A page of the statistics grid; totals = every e-mail of the asked automations together (query.automationIds).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
items | array of EmailStatsItem | ano | |
total | number | ano | |
page | number | ano | |
pageSize | number | ano | |
totals | EmailMetrics | ne |
EmailStatsReport
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
kind | one of: campaign, automation | ano | |
campaignId | string or null | ano | |
automationId | string or null | ano | |
nodeKey | string or null | ano | |
name | string | ano | |
status | string | ano | |
startedAt | string or null | ano | |
completedAt | string or null | ano | |
shopId | string | ano | |
nodes | array of object | ano | |
filters | object | ano | |
firstSentAt | string or null | ano | |
lastSentAt | string or null | ano | |
totals | ReportMetrics | ano | |
baseline | ReportBaseline or null | ano | |
days | array of ReportDay | ano | |
domains | object | ano | |
clients | object | ano | |
systems | object | ano | |
links | array of object | ano | |
unsubscribeReasons | array of object | ano | |
bounceReasons | array of object | ano | |
bounceSplit | object | ano | |
revenue | array of ReportRevenue | ano | |
revenueDays | array of object | ano | |
conversionLinks | array of NamedCount | ano | Orders per clicked link (SE "Nejúspěšnější odkazy"). |
products | array of object | ano | Items sold (quantity) with a picture. |
engagementSpend | array of object | ano | |
topSpenders | array of object | ano |
Error
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
error | object | ano |
{
"error": {
"code": "validation",
"message": "email"
}
}NamedCount
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | '' = the rest (SE "Ostatní"). |
count | number | ano |
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é | Popis |
|---|---|---|---|
sent | number or null | ano | |
openRate | number | ano | |
ctr | number | ano | |
ctor | number | ano | |
complaintRate | number | ano | |
unsubscribeRate | number | ano | |
bounceRate | number | ano | |
deliveryRate | number | ano | |
orderRate | number | ano |
ReportDay
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
date | string | ano | |
opens | number | ano | |
clicks | number | ano | |
unsubscribed | number | ano | |
bounced | number | ano |
ReportMetrics
Rates as SE computes them: openRate, unsubscribeRate and complaintRate over delivered, ctr and orderRate over sent.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
orders | number | ano | |
orderRate | number | ano | |
reopeners | number | ano | E-mails opened more than once, and their share of the opened ones (SE "Opakovaná otevření"). |
reopenRate | number | ano | |
webVersionViews | number | ano | 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 | ano | |
webVersionRate | number | ano | |
printViews | number | ano | |
printUnique | number | ano | |
printRate | number | ano | |
sent | number | ano | |
delivered | number | ano | sent - undelivered |
undelivered | number | ano | Hard or soft bounce (SE "Nedoručeno"). |
bounced | number | ano | |
softBounced | number | ano | |
opens | number | ano | |
uniqueOpens | number | ano | |
repeatedOpens | number | ano | |
machineOpens | number | ano | 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 | ano | |
uniqueClicks | number | ano | |
unsubscribed | number | ano | |
complained | number | ano | |
queued | number | ano | |
failed | number | ano | |
skipped | number | ano | |
openRate | number | ano | |
ctr | number | ano | |
ctor | number | ano | |
unsubscribeRate | number | ano | |
bounceRate | number | ano | |
complaintRate | number | ano | |
deliveryRate | number | ano | delivered / sent |
ReportRevenue
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
currency | Currency | ano | |
orders | number | ano | |
directOrders | number | ano | |
assistedOrders | number | ano | |
total | string | ano | |
direct | string | ano | |
assisted | string | ano | |
averageOrder | string | ano | |
directAverage | string | ano | |
assistedAverage | string | ano | |
eshopOrders | number | ano | |
eshopTotal | string | ano | |
share | number | ano | |
margin | string or null | ne | 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 | ne | |
marginOrders | number | ne | |
directMargin | string or null | ne | |
directMarginAverage | string or null | ne | |
directMarginOrders | number | ne | |
assistedMargin | string or null | ne | |
assistedMarginAverage | string or null | ne | |
assistedMarginOrders | number | ne |
StatsActivity
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
sendId | string | ano | |
contactId | string or null | ano | |
email | string | ano | |
firstAt | string | ano | |
lastAt | string | ano | |
opens | number | ano | |
clicks | number | ano | |
type | StatsActivityType | ano | |
source | string | ano | |
links | array of string | ano | |
detail | string | ano |
StatsActivityType
one of: complaint, unsubscribe, open, click, hard, soft
StatsDay
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
date | string | ano | |
opens | number | ano | |
clicks | number | ano | |
unsubscribed | number | ano |