segments

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-segments"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a1bf95e7-ade8-4fcf-b9dd-0119dc7aeef8/social-card.svg?v=3e7ae33eec8b" alt="segments" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/profiles/{id}/attribute-changes

History of attribute changes (old and new value, source, time), newest first; filter by key

Parameters

keystringquery
limitintegerquery
= 50
cursorstringquery
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "key": "string",
      "old": {},
      "new": {},
      "source": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
profileIdstringrequired
keystringrequired
oldrequired
newrequired
sourcestringrequired
atstringrequired
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/profiles/{id}/attribute-changes

GEThttps://hermeticor.com/v1/attributes/computed

Computed attributes: event aggregates recomputed hourly onto profiles

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "eventName": "string",
      "fn": "count",
      "property": "string",
      "keyProperty": "string",
      "sourceKeys": [
        "string"
      ],
      "where": {},
      "windowDays": 0,
      "maxItems": 0,
      "status": "active",
      "lastComputedAt": "2024-01-01T00:00:00Z",
      "lastChangedCount": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem10[]required
Show child parameters
idstringrequired
keystringrequired
labelstringrequired
eventNamestringrequired
fnstringrequired
count | sum | avg | min | max | first | last | distinct_count | list | keyed_latest | any_of | group | performed_many
propertystringrequired
keyPropertystringrequired
sourceKeysstring[]required
whereobjectrequired
windowDaysintegerrequired
maxItemsintegerrequired
statusstringrequired
active | paused
lastComputedAtstringrequired
lastChangedCountintegerrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

POSThttps://hermeticor.com/v1/attributes/computed

Request body

application/json
keystringrequired
labelstring
eventNamestring
fnstringrequired
count | sum | avg | min | max | first | last | distinct_count | list | keyed_latest | any_of | group | performed_many
sourceKeysstring[]
propertystring
keyPropertystring
whereobject
windowDaysinteger
maxItemsinteger
statusstring
active | paused = active
{
  "key": "string",
  "label": "string",
  "eventName": "",
  "fn": "count",
  "sourceKeys": [
    "string"
  ],
  "property": "string",
  "keyProperty": "string",
  "where": {},
  "windowDays": 0,
  "maxItems": 0,
  "status": "active"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/attributes/computed" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","eventName":"","fn":"count","sourceKeys":["string"],"property":"string","keyProperty":"string","where":{},"windowDays":0,"maxItems":0,"status":"active"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "key": "string",
  "label": "string",
  "eventName": "string",
  "fn": "count",
  "property": "string",
  "keyProperty": "string",
  "sourceKeys": [
    "string"
  ],
  "where": {},
  "windowDays": 0,
  "maxItems": 0,
  "status": "active",
  "lastComputedAt": "2024-01-01T00:00:00Z",
  "lastChangedCount": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
keystringrequired
labelstringrequired
eventNamestringrequired
fnstringrequired
count | sum | avg | min | max | first | last | distinct_count | list | keyed_latest | any_of | group | performed_many
propertystringrequired
keyPropertystringrequired
sourceKeysstring[]required
whereobjectrequired
windowDaysintegerrequired
maxItemsintegerrequired
statusstringrequired
active | paused
lastComputedAtstringrequired
lastChangedCountintegerrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

POSThttps://hermeticor.com/v1/attributes/computed/run

Recompute all computed attributes now

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/attributes/computed/run" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "queued": true
}
Schema
queuedbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

GEThttps://hermeticor.com/v1/attributes/computed/{key}

Parameters

keystringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/attributes/computed

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

DELETEhttps://hermeticor.com/v1/attributes/computed/{key}

Parameters

keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/attributes/computed/{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/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

PATCHhttps://hermeticor.com/v1/attributes/computed/{key}

Parameters

keystringpathrequired

Request body

application/json
labelstring
eventNamestring
fnstring
count | sum | avg | min | max | first | last | distinct_count | list | keyed_latest | any_of | group | performed_many
sourceKeysstring[]
propertystring
keyPropertystring
whereobject
windowDaysinteger
maxItemsinteger
statusstring
active | paused
{
  "label": "string",
  "eventName": "string",
  "fn": "count",
  "sourceKeys": [
    "string"
  ],
  "property": "string",
  "keyProperty": "string",
  "where": {},
  "windowDays": 0,
  "maxItems": 0,
  "status": "active"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/attributes/computed/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","eventName":"string","fn":"count","sourceKeys":["string"],"property":"string","keyProperty":"string","where":{},"windowDays":0,"maxItems":0,"status":"active"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/attributes/computed

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

GEThttps://hermeticor.com/v1/attributes/field-groups

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "position": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem11[]required
Show child parameters
idstringrequired
keystringrequired
labelstringrequired
positionintegerrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/attribute-changes

Updated