bulk

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-bulk"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/e0b7a378-f5a0-43b9-944e-5efff065021b/social-card.svg?v=3e7ae33eec8b" alt="bulk" width="600" height="315"></a>
POSThttps://hermetica.15.204.158.166.sslip.io/v1/exports

Export a segment, a list or all profiles to CSV, NDJSON or XLSX, with chosen columns (`attributes.<key>` for a custom property); poll GET /v1/exports/:id for the signed download URL

Request body

application/json
selectorobjectrequired
Show child parameters
profileIdsstring[]
listIdstring
segmentIdstring
allboolean
true
filterobject
Show child parameters
qstring
tagstring
tagsAnystring
tagsAllstring
listIdstring
emailstring
phonestring
createdSincestring
createdBeforestring
updatedSincestring
updatedBeforestring
attrKeystring
attrValuestring
vipstring
true | false
consentStatusstring
granted | revoked | pending_confirmation | none
consentChannelstring
email | sms | whatsapp | push | postcard
consentSincestring
topicIdstring
countrystring
regionstring
citystring
segmentIdstring
eventNamestring
eventSincestring
eventBeforestring
sourcestring
archivedstring
only | include
attrOpstring
eq | contains | gt | lt = eq
notifyEmailstring
columnsstring[]
formatstring
csv | ndjson | xlsx = csv
{
  "selector": {
    "profileIds": [
      "string"
    ],
    "listId": "string",
    "segmentId": "string",
    "all": true,
    "filter": {
      "q": "string",
      "tag": "string",
      "tagsAny": "string",
      "tagsAll": "string",
      "listId": "string",
      "email": "string",
      "phone": "string",
      "createdSince": "2024-01-01T00:00:00Z",
      "createdBefore": "2024-01-01T00:00:00Z",
      "updatedSince": "2024-01-01T00:00:00Z",
      "updatedBefore": "2024-01-01T00:00:00Z",
      "attrKey": "string",
      "attrValue": "string",
      "vip": "true",
      "consentStatus": "granted",
      "consentChannel": "email",
      "consentSince": "2024-01-01T00:00:00Z",
      "topicId": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "segmentId": "string",
      "eventName": "string",
      "eventSince": "2024-01-01T00:00:00Z",
      "eventBefore": "2024-01-01T00:00:00Z",
      "source": "string",
      "archived": "only",
      "attrOp": "eq"
    }
  },
  "notifyEmail": "string",
  "columns": [
    "id"
  ],
  "format": "csv"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/exports" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"selector":{"profileIds":["string"],"listId":"string","segmentId":"string","all":true,"filter":{"q":"string","tag":"string","tagsAny":"string","tagsAll":"string","listId":"string","email":"string","phone":"string","createdSince":"2024-01-01T00:00:00Z","createdBefore":"2024-01-01T00:00:00Z","updatedSince":"2024-01-01T00:00:00Z","updatedBefore":"2024-01-01T00:00:00Z","attrKey":"string","attrValue":"string","vip":"true","consentStatus":"granted","consentChannel":"email","consentSince":"2024-01-01T00:00:00Z","topicId":"string","country":"string","region":"string","city":"string","segmentId":"string","eventName":"string","eventSince":"2024-01-01T00:00:00Z","eventBefore":"2024-01-01T00:00:00Z","source":"string","archived":"only","attrOp":"eq"}},"notifyEmail":"string","columns":["id"],"format":"csv"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
bulk | export
opstringrequired
statusstringrequired
queued | running | completed | failed
progressobjectrequired
Show child parameters
totalintegerrequired
processedintegerrequired
failedintegerrequired
errorstringrequired
downloadUrlstring
failuresobject[]
Show child parameters
profileIdstringrequired
messagestringrequired
createdAtstringrequired
finishedAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/exports

GEThttps://hermetica.15.204.158.166.sslip.io/v1/jobs/{id}/stream

Live progress of a bulk job or export as server-sent events (event: progress, then event: done)

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/jobs/{id}/stream" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · POST /v1/exports

5XX Default Response

Same as 4XX · POST /v1/exports

Updated