landing-pages

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-landing-pages"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c6be5417-6c86-4c1d-96eb-b62b10fbdcb8/social-card.svg?v=3e7ae33eec8b" alt="landing-pages" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/landing-pages

Filter by name, state, site, folder, language, archived and created/updated ranges; sort by created, updated or name

Parameters

limitintegerquery
= 50
cursorstringquery
namestringquery
createdFromstringquery
createdTostringquery
updatedFromstringquery
updatedTostringquery
sortstringquery
created | -created | updated | -updated | name | -name = -created
folderIdstringquery
localestringquery
siteIdstringquery
statusstringquery
draft | published
archivedstringquery
true | false

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "status": "draft",
      "publishedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem75[]required
Show child parameters
idstringrequired
namestringrequired
slugstringrequired
statusstringrequired
draft | published
publishedAtstringrequired
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/landing-pages

POSThttps://hermeticor.com/v1/landing-pages

Create a page; `template_id` starts it from a preset when `doc` is left out

Request body

application/json
namestringrequired
slugstringrequired
seoTitlestring
seoDescriptionstring
docobject
Show child parameters
versionnumber
1 = 1
widthinteger
= 600
backgroundstring
blocksschema0[]required
translationsobject
formIdstring
folderIdstring
localestring
noindexboolean
headScriptsstring
redirectobject
Show child parameters
urlstringrequired
statusnumber
= 302
unpublishAtstring
template_idstring
blank | lead_capture | webinar | product_launch | coming_soon | ebook | event | thank_you
siteIdstring
{
  "name": "string",
  "slug": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "doc": {
    "version": 1,
    "width": 600,
    "background": "string",
    "blocks": [
      {}
    ],
    "translations": {}
  },
  "formId": "string",
  "folderId": "string",
  "locale": "string",
  "noindex": true,
  "headScripts": "string",
  "redirect": {
    "url": "string",
    "status": 302
  },
  "unpublishAt": "2024-01-01T00:00:00Z",
  "template_id": "blank",
  "siteId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/landing-pages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","seoTitle":"string","seoDescription":"string","doc":{"version":1,"width":600,"background":"string","blocks":[{}],"translations":{}},"formId":"string","folderId":"string","locale":"string","noindex":true,"headScripts":"string","redirect":{"url":"string","status":302},"unpublishAt":"2024-01-01T00:00:00Z","template_id":"blank","siteId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "draft",
  "publishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
slugstringrequired
statusstringrequired
draft | published
publishedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

GEThttps://hermeticor.com/v1/landing-pages/report

Visits, sign-ups, conversion and video plays for every page over a window

Parameters

daysintegerquery
= 30

Code samples

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

Responses

200 Default Response
Example
{
  "days": 0,
  "items": [
    {
      "pageId": "string",
      "name": "string",
      "slug": "string",
      "status": "string",
      "visits": 0,
      "uniqueVisitors": 0,
      "signups": 0,
      "conversion": 0,
      "videoPlays": 0,
      "clicks": 0,
      "orders": 0,
      "revenueMinor": 0,
      "currency": "string"
    }
  ]
}
Schema
daysintegerrequired
itemsobject[]required
Show child parameters
pageIdstringrequired
namestringrequired
slugstringrequired
statusstringrequired
visitsintegerrequired
uniqueVisitorsintegerrequired
signupsintegerrequired
conversionnumberrequired
videoPlaysintegerrequired
clicksintegerrequired
ordersintegerrequired
revenueMinorintegerrequired
currencystringrequired
4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

GEThttps://hermeticor.com/v1/landing-pages/not-found

Page addresses visitors requested that serve nothing, most requested first

Parameters

daysintegerquery
= 30

Code samples

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

Responses

200 Default Response
Example
{
  "days": 0,
  "items": [
    {
      "slug": "string",
      "hits": 0,
      "lastAt": "string"
    }
  ]
}
Schema
daysintegerrequired
itemsobject[]required
Show child parameters
slugstringrequired
hitsintegerrequired
lastAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

GEThttps://hermeticor.com/v1/landing-pages/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/landing-pages

4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

DELETEhttps://hermeticor.com/v1/landing-pages/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

PATCHhttps://hermeticor.com/v1/landing-pages/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
slugstring
seoTitlestring
seoDescriptionstring
docobject
Show child parameters
versionnumber
1 = 1
widthinteger
= 600
backgroundstring
blocksschema0[]required
translationsobject
formIdstring
folderIdstring
localestring
noindexboolean
headScriptsstring
redirectobject
Show child parameters
urlstringrequired
statusnumber
= 302
unpublishAtstring
{
  "name": "string",
  "slug": "string",
  "seoTitle": "string",
  "seoDescription": "string",
  "doc": {
    "version": 1,
    "width": 600,
    "background": "string",
    "blocks": [
      {}
    ],
    "translations": {}
  },
  "formId": "string",
  "folderId": "string",
  "locale": "string",
  "noindex": true,
  "headScripts": "string",
  "redirect": {
    "url": "string",
    "status": 302
  },
  "unpublishAt": "2024-01-01T00:00:00Z"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/landing-pages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","seoTitle":"string","seoDescription":"string","doc":{"version":1,"width":600,"background":"string","blocks":[{}],"translations":{}},"formId":"string","folderId":"string","locale":"string","noindex":true,"headScripts":"string","redirect":{"url":"string","status":302},"unpublishAt":"2024-01-01T00:00:00Z"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/landing-pages

4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

POSThttps://hermeticor.com/v1/landing-pages/{id}/publish

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/landing-pages/{id}/publish" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/landing-pages

4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

POSThttps://hermeticor.com/v1/landing-pages/{id}/unpublish

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/landing-pages/{id}/unpublish" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/landing-pages

4XX Default Response

Same as 4XX · GET /v1/landing-pages

5XX Default Response

Same as 4XX · GET /v1/landing-pages

Updated