Preskočiť na obsah
API dokumentácia

SmartEmailing compatible CSV statistics

Semicolon separated CSV as SmartEmailing /api/csv: e-mail statistic ids, per-contact event details, list members.

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=SmartEmailing%20CSV.

Operácie

MetódaCestaPopis
GET/api/csv/list-contactsMembers of a list (CSV)
GET/api/csv/statistics/email/automation-email-statistic-idE-mail statistic ids of automation e-mail nodes
GET/api/csv/statistics/email/automation-email-statistic-id/{automation_id}E-mail statistic ids of automation e-mail nodes of one automation
GET/api/csv/statistics/email/{kind}-detail/{sid}Per-contact events of an e-mail statistic id (sent, opened, clicked, bounced, unsubscribed)

Members of a list (CSV)

GET /api/csv/list-contacts

Parametre

NázovKdeTypPovinnéPopis
listidqueryintegeráno

Odpovede

  • 200 OK: text/csv string

Chyby

StavKódHodnoty message
401Authentication Failed
403Forbidden
404Not Found
422Validation failed: <parameter>
429Rate limit exceeded (...)

E-mail statistic ids of automation e-mail nodes

GET /api/csv/statistics/email/automation-email-statistic-id

Odpovede

  • 200 OK: text/csv string

Chyby

StavKódHodnoty message
401Authentication Failed
403Forbidden
429Rate limit exceeded (...)

E-mail statistic ids of automation e-mail nodes of one automation

GET /api/csv/statistics/email/automation-email-statistic-id/{automation_id}

Parametre

NázovKdeTypPovinnéPopis
automation_idpathintegeráno

Odpovede

  • 200 OK: text/csv string

Chyby

StavKódHodnoty message
401Authentication Failed
403Forbidden
429Rate limit exceeded (...)

Per-contact events of an e-mail statistic id (sent, opened, clicked, bounced, unsubscribed)

GET /api/csv/statistics/email/{kind}-detail/{sid}

Parametre

NázovKdeTypPovinnéPopis
kindpathone of: sent, opened, clicked, bounced, unsubscribedáno
sidpathstringánoc<campaign id> or a<automation id>:<node key>.
interval_fromquerystringnieYYYY-MM-DD HH:MM:SS local time.
interval_toquerystringnieYYYY-MM-DD HH:MM:SS local time.

Odpovede

  • 200 OK: text/csv string

Chyby

StavKódHodnoty message
401Authentication Failed
403Forbidden
404Not Found
422Validation failed: <parameter>
429Rate limit exceeded (...)

Schémy

SeError

PoleTypPovinnéPopis
statuserroráno
metaarray of anynie
messagestringáno
json
{
  "status": "error",
  "meta": [],
  "message": "Authentication Failed"
}