newsletter-growth

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-newsletter-growth"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9146c49f-fdeb-4eb6-9b41-8433f17c6781/social-card.svg?v=3e7ae33eec8b" alt="newsletter-growth" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/newsletter/growth/dashboard/{publicationId}

Growth dashboard: totals, net growth per day, sources, churn, cohorts, top posts

Parameters

daysintegerquery
= 30
publicationIdstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "total": 0,
  "paid": 0,
  "free": 0,
  "pending": 0,
  "joined": 0,
  "left": 0,
  "churnRate": 0,
  "daily": [
    {
      "day": "string",
      "joined": 0,
      "left": 0,
      "net": 0,
      "total": 0
    }
  ],
  "sources": [
    {
      "source": "string",
      "count": 0
    }
  ],
  "cohorts": [
    {
      "week": "string",
      "size": 0,
      "retained": [
        0
      ]
    }
  ],
  "topPosts": [
    {
      "post": "string",
      "signups": 0
    }
  ]
}
Schema
totalintegerrequired
paidintegerrequired
freeintegerrequired
pendingintegerrequired
joinedintegerrequired
leftintegerrequired
churnRatenumberrequired
dailyobject[]required
Show child parameters
daystringrequired
joinedintegerrequired
leftintegerrequired
netintegerrequired
totalintegerrequired
sourcesobject[]required
Show child parameters
sourcestringrequired
countintegerrequired
cohortsobject[]required
Show child parameters
weekstringrequired
sizeintegerrequired
retainednumber[]required
topPostsobject[]required
Show child parameters
poststringrequired
signupsintegerrequired
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/newsletter/growth/dashboard/{publicationId}

GEThttps://hermeticor.com/p/ng/{ws}/{pub}

Hosted subscribe page for a publication

Parameters

embedstringquery
refstringquery
booststringquery
poststringquery
wsstringpathrequired
pubstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/ng/{ws}/{pub}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

POSThttps://hermeticor.com/p/ng/{ws}/{pub}

Subscribe through a publication surface (consent checkbox required; double opt-in respected)

Parameters

wsstringpathrequired
pubstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/ng/{ws}/{pub}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

GEThttps://hermeticor.com/p/ng/{ws}/{pub}/widget.js

Popup, slide-in and scroll-trigger script for a publication

Parameters

wsstringpathrequired
pubstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/ng/{ws}/{pub}/widget.js"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

POSThttps://hermeticor.com/p/ng/{ws}/{pub}/recommend/{listing}

Subscribe to a recommended publication

Parameters

wsstringpathrequired
pubstringpathrequired
listingstringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermeticor.com/p/ng/{ws}/{pub}/recommend/{listing}" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

GEThttps://hermeticor.com/p/ng/{ws}/s/{token}

One-click subscribe confirmation page (does not change state)

Parameters

wsstringpathrequired
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/p/ng/{ws}/s/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

POSThttps://hermeticor.com/p/ng/{ws}/s/{token}

Subscribe the address a one-click link names (consent, suppression and double opt-in apply; idempotent)

Parameters

wsstringpathrequired
tokenstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/p/ng/{ws}/s/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

POSThttps://hermeticor.com/v1/newsletter/growth/subscribe-links/{publicationId}

Mint a signed one-click subscribe link for one address

Parameters

publicationIdstringpathrequired

Request body

application/json
emailstringrequired
sourcestring
= api
expiresInDaysinteger
= 30
{
  "email": "string",
  "source": "api",
  "expiresInDays": 30
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/growth/subscribe-links/{publicationId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","source":"api","expiresInDays":30}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "mergeTag": "string"
}
Schema
urlstringrequired
expiresAtstringrequired
mergeTagstringrequired
4XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

5XX Default Response

Same as 4XX · GET /v1/newsletter/growth/dashboard/{publicationId}

Updated