Přeskočit na obsah
API dokumentace

SmartEmailing compatible CSV statistics

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

Technická reference je anglicky (stejně jako strojově čitelný dokument OpenAPI). Celou skupinu pro AI agenta načtete z /api/openapi.json?tag=SmartEmailing%20CSV.

Operace

MetodaCestaPopis
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

Parametry

NázevKdeTypPovinnéPopis
listidqueryintegerano

Odpovědi

  • 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

Odpovědi

  • 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}

Parametry

NázevKdeTypPovinnéPopis
automation_idpathintegerano

Odpovědi

  • 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}

Parametry

NázevKdeTypPovinnéPopis
kindpathone of: sent, opened, clicked, bounced, unsubscribedano
sidpathstringanoc<campaign id> or a<automation id>:<node key>.
interval_fromquerystringneYYYY-MM-DD HH:MM:SS local time.
interval_toquerystringneYYYY-MM-DD HH:MM:SS local time.

Odpovědi

  • 200 OK: text/csv string

Chyby

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

Schémata

SeError

PoleTypPovinnéPopis
statuserrorano
metaarray of anyne
messagestringano
json
{
  "status": "error",
  "meta": [],
  "message": "Authentication Failed"
}