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>
POSThttps://hermeticor.com/v1/attributes/fields/{key}/type-check

Dry run of a field type change: how many stored profile values fit the new type, with examples of those that do not

Parameters

keystringpathrequired

Request body

application/json
typestringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
choicesstring[]
{
  "type": "text",
  "choices": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/attributes/fields/{key}/type-check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"text","choices":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "key": "string",
  "from": "text",
  "to": "text",
  "total": 0,
  "valid": 0,
  "invalid": 0,
  "samples": [
    {
      "profileId": "string",
      "value": {}
    }
  ]
}
Schema
keystringrequired
fromstringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
tostringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
totalintegerrequired
validintegerrequired
invalidintegerrequired
samplesobject[]required
Show child parameters
profileIdstringrequired
valuerequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

GEThttps://hermeticor.com/v1/segments

Parameters

limitintegerquery
= 50
cursorstringquery
qstringquery
idsstringquery
createdFromstringquery
createdTostringquery
updatedFromstringquery
updatedTostringquery
activestringquery
true | false
starredstringquery
true | false
sortstringquery
name | -name | created_at | -created_at | updated_at | -updated_at | member_count | -member_count

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "folder": "string",
      "definition": {
        "type": "group",
        "op": "and",
        "negate": true,
        "children": [
          {}
        ]
      },
      "status": "active",
      "evalStatus": "pending",
      "lastEvaluatedAt": "2024-01-01T00:00:00Z",
      "memberCount": 0,
      "dependencyKeys": [
        "string"
      ],
      "version": 0,
      "subject": "string",
      "starred": true,
      "tags": [
        "string"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem41[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
folderstringrequired
definitionobjectrequired
Show child parameters
typestringrequired
group
opstringrequired
and | or
negateboolean
childrenschema0[]required
statusstringrequired
active | archived
evalStatusstringrequired
pending | ready | failed
lastEvaluatedAtstringrequired
memberCountintegerrequired
dependencyKeysstring[]required
versionintegerrequired
subjectstringrequired
starredbooleanrequired
tagsstring[]
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

5XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

PUThttps://hermeticor.com/v1/segments

Create or update by name: the live segment with this name (case-insensitive) gets these rules, else a new one is made

Request body

application/json
namestringrequired
descriptionstring
folderstring
definitionobjectrequired
Show child parameters
typestringrequired
group
opstringrequired
and | or
negateboolean
childrenschema0[]required
tagsstring[]
subjectstring
starredboolean
{
  "name": "string",
  "description": "string",
  "folder": "string",
  "definition": {
    "type": "group",
    "op": "and",
    "negate": true,
    "children": [
      {}
    ]
  },
  "tags": [
    "string"
  ],
  "subject": "string",
  "starred": true
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/segments" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","folder":"string","definition":{"type":"group","op":"and","negate":true,"children":[{}]},"tags":["string"],"subject":"string","starred":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "folder": "string",
  "definition": {
    "type": "group",
    "op": "and",
    "negate": true,
    "children": [
      {}
    ]
  },
  "status": "active",
  "evalStatus": "pending",
  "lastEvaluatedAt": "2024-01-01T00:00:00Z",
  "memberCount": 0,
  "dependencyKeys": [
    "string"
  ],
  "version": 0,
  "subject": "string",
  "starred": true,
  "tags": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "created": true
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
folderstringrequired
definitionobjectrequired
Show child parameters
typestringrequired
group
opstringrequired
and | or
negateboolean
childrenschema0[]required
statusstringrequired
active | archived
evalStatusstringrequired
pending | ready | failed
lastEvaluatedAtstringrequired
memberCountintegerrequired
dependencyKeysstring[]required
versionintegerrequired
subjectstringrequired
starredbooleanrequired
tagsstring[]
createdAtstringrequired
updatedAtstringrequired
createdbooleanrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

5XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

POSThttps://hermeticor.com/v1/segments

Request body

application/json
namestringrequired
descriptionstring
folderstring
definitionobjectrequired
Show child parameters
typestringrequired
group
opstringrequired
and | or
negateboolean
childrenschema0[]required
tagsstring[]
subjectstring
starredboolean
{
  "name": "string",
  "description": "string",
  "folder": "string",
  "definition": {
    "type": "group",
    "op": "and",
    "negate": true,
    "children": [
      {}
    ]
  },
  "tags": [
    "string"
  ],
  "subject": "string",
  "starred": true
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/segments" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","folder":"string","definition":{"type":"group","op":"and","negate":true,"children":[{}]},"tags":["string"],"subject":"string","starred":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "folder": "string",
  "definition": {
    "type": "group",
    "op": "and",
    "negate": true,
    "children": [
      {}
    ]
  },
  "status": "active",
  "evalStatus": "pending",
  "lastEvaluatedAt": "2024-01-01T00:00:00Z",
  "memberCount": 0,
  "dependencyKeys": [
    "string"
  ],
  "version": 0,
  "subject": "string",
  "starred": true,
  "tags": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
folderstringrequired
definitionobjectrequired
Show child parameters
typestringrequired
group
opstringrequired
and | or
negateboolean
childrenschema0[]required
statusstringrequired
active | archived
evalStatusstringrequired
pending | ready | failed
lastEvaluatedAtstringrequired
memberCountintegerrequired
dependencyKeysstring[]required
versionintegerrequired
subjectstringrequired
starredbooleanrequired
tagsstring[]
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

5XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

POSThttps://hermeticor.com/v1/segments/{id}/clone

Copy a segment (rules, folder, tags) under a new name

Parameters

idstringpathrequired

Request body

application/json
namestring
{
  "name": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/segments/{id}/clone" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response

Same as 201 · POST /v1/segments

4XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

5XX Default Response

Same as 4XX · POST /v1/attributes/fields/{key}/type-check

Updated