audience

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-audience"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/00a88c56-41bf-432b-86f8-7c784663e81e/social-card.svg?v=3e7ae33eec8b" alt="audience" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/exports/activity

CSV export of the profile activity timeline (poll GET /v1/exports/:id)

Request body

application/json
fromstring
tostring
channelstring
email | sms | whatsapp
notifyEmailstring
{
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "channel": "email",
  "notifyEmail": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/exports/activity" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z","channel":"email","notifyEmail":"string"}'
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
failuresFailuresItem[]
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/activity

POSThttps://hermeticor.com/v1/exports/suppressions

CSV export of suppressions (rejects)

Request body

application/json
fromstring
tostring
channelstring
email | sms | whatsapp
notifyEmailstring
{
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "channel": "email",
  "notifyEmail": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/exports/suppressions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2024-01-01T00:00:00Z","to":"2024-01-01T00:00:00Z","channel":"email","notifyEmail":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response

Same as 202 · POST /v1/exports/activity

4XX Default Response

Same as 4XX · POST /v1/exports/activity

5XX Default Response

Same as 4XX · POST /v1/exports/activity

Updated