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>
GEThttps://hermeticor.com/v1/lists/{id}/growth-history

Daily sign-ups, imports, other adds, removals, pending opt-ins and the running member total of one list

Parameters

fromstringquery
tostringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/growth-history" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "listId": "string",
  "items": [
    {
      "day": "string",
      "subs": 0,
      "imports": 0,
      "otherAdds": 0,
      "removed": 0,
      "pending": 0,
      "total": 0,
      "unsubs": 0,
      "cleaned": 0,
      "otherRemoves": 0,
      "deleted": 0
    }
  ]
}
Schema
listIdstringrequired
itemsobject[]required
Show child parameters
daystringrequired
subsintegerrequired
importsintegerrequired
otherAddsintegerrequired
removedintegerrequired
pendingintegerrequired
totalintegerrequired
unsubsintegerrequired
cleanedintegerrequired
otherRemovesintegerrequired
deletedintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/lists/{id}/activity

Per-day sends, deliveries, opens, clicks, bounces and complaints for the people on this list

Parameters

fromstringquery
tostringquery
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/activity" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "day": "string",
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "clicked": 0,
      "bounced": 0,
      "complaints": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
daystringrequired
sentintegerrequired
deliveredintegerrequired
openedintegerrequired
clickedintegerrequired
bouncedintegerrequired
complaintsintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/lists/{id}/clients

Opens or clicks by email client, device or country for this list

Parameters

fromstringquery
tostringquery
bystringquery
country | client | device = client
kindstringquery
open | click = open
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/clients" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "by": "string",
  "kind": "string",
  "rows": [
    {
      "key": "string",
      "events": 0,
      "unique": 0
    }
  ]
}
Schema
bystringrequired
kindstringrequired
rowsRowsItem[]required
Show child parameters
keystringrequired
eventsintegerrequired
uniqueintegerrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/lists/{id}/abuse-reports

Parameters

limitintegerquery
= 50
cursorstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/abuse-reports" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "jobId": "string",
      "profileId": "string",
      "destination": "string",
      "sourceKind": "string",
      "sourceId": "string",
      "subject": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem6[]required
Show child parameters
idstringrequired
jobIdstringrequired
profileIdstringrequired
destinationstringrequired
sourceKindstringrequired
sourceIdstringrequired
subjectstringrequired
atstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/lists/{id}/abuse-reports/{reportId}

Parameters

idstringpathrequired
reportIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/abuse-reports/{reportId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "jobId": "string",
  "profileId": "string",
  "destination": "string",
  "sourceKind": "string",
  "sourceId": "string",
  "subject": "string",
  "at": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
jobIdstringrequired
profileIdstringrequired
destinationstringrequired
sourceKindstringrequired
sourceIdstringrequired
subjectstringrequired
atstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/lists/{id}/members/{profileId}/goals

Goals one list member reached (conversions with value and what drove them)

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired
profileIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/lists/{id}/members/{profileId}/goals" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "goalKey": "string",
      "at": "2024-01-01T00:00:00Z",
      "valueMinor": 0,
      "currency": "string",
      "attributedKind": "string",
      "attributedId": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
goalKeystringrequired
atstringrequired
valueMinorintegerrequired
currencystringrequired
attributedKindstringrequired
attributedIdstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/activity/highlights

Marketer feed over the chosen window: finished sends, each sign-up one by one, daily list growth and the audience milestone reached; paged by time

Parameters

daysintegerquery
= 14
limitintegerquery
= 30
cursorstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/activity/highlights" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "at": "2024-01-01T00:00:00Z",
      "kind": "send",
      "text": "string",
      "targetId": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
atstringrequired
kindstringrequired
send | growth | signup | milestone
textstringrequired
targetIdstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

GEThttps://hermeticor.com/v1/analytics/audience-sources/{kind}

Companies (contacts per company), devices and UTM (by `by`), do-not-contact entries, and score points by reason

Parameters

listIdstringquery
fromstringquery
tostringquery
intervalstringquery
day | month = day
bystringquery
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
kindstringpathrequired
companies | devices | utm | dnc | points

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/analytics/audience-sources/{kind}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "string",
      "count": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem13[]required
Show child parameters
keystringrequired
countintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

5XX Default Response

Same as 4XX · GET /v1/lists/{id}/growth-history

Updated