audience

Embed

<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/analytics/audience/growth

Audience growth per day/month: subscribes, unsubscribes, created

Parameters

listIdstringquery

fromstringquery

tostringquery

intervalstringquery

day | month = day

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/audience/growth" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "period": "string",
      "subscribes": 0,
      "unsubscribes": 0,
      "created": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

periodstringrequired

subscribesintegerrequired

unsubscribesintegerrequired

createdintegerrequired

nextCursorstringrequired

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/analytics/audience/growth

GEThttps://hermeticor.com/v1/analytics/audience/locations

Parameters

listIdstringquery

fromstringquery

tostringquery

intervalstringquery

day | month = day

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/audience/locations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

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/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

GEThttps://hermeticor.com/v1/analytics/audience/sources

Parameters

listIdstringquery

fromstringquery

tostringquery

intervalstringquery

day | month = day

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/audience/sources" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/analytics/audience/locations

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

GEThttps://hermeticor.com/v1/analytics/audience/engagement

Timeline activity by kind (sends, opens, clicks, notes ...)

Parameters

listIdstringquery

fromstringquery

tostringquery

intervalstringquery

day | month = day

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/analytics/audience/engagement" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/analytics/audience/locations

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

GEThttps://hermeticor.com/v1/activity

Recent workspace activity feed built from the audit log; filter by target type, action and person

Parameters

limitintegerquery

= 50

cursorstringquery

typestringquery

namestringquery

profileIdstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/activity" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "at": "2024-01-01T00:00:00Z",
      "action": "string",
      "summary": "string",
      "targetType": "string",
      "targetId": "string",
      "actorType": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

atstringrequired

actionstringrequired

summarystringrequired

targetTypestringrequired

targetIdstringrequired

actorTypestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

GEThttps://hermeticor.com/v1/jobs

Bulk jobs and exports, newest first

Parameters

limitintegerquery

= 50

cursorstringquery

kindstringquery

bulk | export

statusstringquery

queued | running | completed | failed

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/jobs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem14[]required

Show child parameters

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

DELETEhttps://hermeticor.com/v1/jobs/{id}

Delete a finished job

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/jobs/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

GEThttps://hermeticor.com/v1/exports

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/exports" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/jobs

4XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

5XX Default Response

Same as 4XX · GET /v1/analytics/audience/growth

Next part

Updated Nov 8, 2026

Was this page helpful?