Docs

Export campaign data as CSV

Guide: Campaigns
GET
/advanced/campaigns/{campaignId}/export

Returns a CSV file (UTF-8 with BOM, Content-Disposition: attachment). contacts: one line per contact with its custom fields, activities and replied flag; activities: activity log; replies: replies. Optional date range on activities.

Authorization

apiKey
Authorization<token>

Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.

In: header

Path Parameters

campaignId*string

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Match^[0-9a-fA-F]{24}$

Query Parameters

type*string

Value in

  • "contacts"
  • "activities"
  • "replies"
start?string
Formatdate-time
end?string
Formatdate-time

Response Body

text/csv

application/json

application/json

application/json

curl -X GET "https://example.com/advanced/campaigns/6650f1a2b839d80011c5a0f1/export?type=contacts" \  -H "Authorization: YOUR_API_KEY"
"string"

GETList the contacts of a step

Contacts that passed (completed) or wait at (waiting) a given step, newest first, 20 per page.

GETGet campaign statistics

Global and per step statistics of a multichannel campaign.