sites

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-sites"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/ae5b2193-2438-4617-9c90-2cccf3eb3194/social-card.svg?v=3e7ae33eec8b" alt="sites" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/content-slots

Parameters

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/content-slots" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "name": "string",
      "defaultHtml": "",
      "rules": [],
      "enabled": true,
      "id": "string",
      "key": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem160[]required
Show child parameters
namestringrequired
defaultHtmlstringrequired
rulesRulesItem7[]required
= []
Show child parameters
idstringrequired
segmentIdsstring[]required
= []
identifiedboolean
htmlstringrequired
enabledbooleanrequired
= true
idstringrequired
keystringrequired
createdAtstringrequired
updatedAtstringrequired
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/content-slots

PUThttps://hermeticor.com/v1/content-slots/{key}

Create or replace a slot: first matching segment rule wins, else the default

Parameters

keystringpathrequired

Request body

application/json
namestringrequired
defaultHtmlstring
rulesobject[]
= []
Show child parameters
idstringrequired
segmentIdsstring[]
= []
identifiedboolean
htmlstringrequired
enabledboolean
= true
{
  "name": "string",
  "defaultHtml": "",
  "rules": [],
  "enabled": true
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/content-slots/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","defaultHtml":"","rules":[],"enabled":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "name": "string",
  "defaultHtml": "",
  "rules": [],
  "enabled": true,
  "id": "string",
  "key": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
namestringrequired
defaultHtmlstringrequired
rulesRulesItem7[]required
= []
Show child parameters
idstringrequired
segmentIdsstring[]required
= []
identifiedboolean
htmlstringrequired
enabledbooleanrequired
= true
idstringrequired
keystringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

DELETEhttps://hermeticor.com/v1/content-slots/{key}

Parameters

keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/content-slots/{key}" \
  -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/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

GEThttps://hermeticor.com/ingest/v1/slots.js

Snippet: <script src=".../ingest/v1/slots.js?k=SITE_KEY"> then mark elements with data-hermetica-slot="key"

Code samples

cURL
curl -X GET "https://hermeticor.com/ingest/v1/slots.js"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

GEThttps://hermeticor.com/ingest/v1/slots

Slot content for the visitor: identified profiles get their segment rules

Parameters

slotsstringquery
aidstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "slots": {}
}
Schema
slotsobjectrequired
4XX Default Response

Same as 4XX · GET /v1/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

GEThttps://hermeticor.com/v1/content-slots/pushes

Live content journeys pushed into individual visitors' slots

Parameters

slotKeystringquery
profileIdstringquery
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/content-slots/pushes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "slotKey": "string",
      "html": "string",
      "expiresAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
profileIdstringrequired
slotKeystringrequired
htmlstringrequired
expiresAtstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

DELETEhttps://hermeticor.com/v1/content-slots/pushes/{id}

Withdraw pushed content (the slot falls back to its rules)

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/content-slots/{key}

4XX Default Response

Same as 4XX · GET /v1/content-slots

5XX Default Response

Same as 4XX · GET /v1/content-slots

Updated