segments

Embed

<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/segments/suggest

Most common real values of an event property or profile field, for builder dropdowns

Parameters

sourcestringqueryrequired

event | profile | consent

namestringquery

pathstringqueryrequired

channelstringquery

email | sms | whatsapp | push | postcard

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/segments/suggest?source=event&path=<path>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "values": [
    {
      "value": "string",
      "count": 0
    }
  ]
}

Schema

valuesValuesItem[]required

Show child parameters

valuestringrequired

countintegerrequired

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/segments/suggest

GEThttps://hermeticor.com/v1/segments/{id}/export

Current members as CSV text (first 50,000); POST /v1/segments/:id/export-jobs exports every member as a file

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/segments/{id}/export" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "filename": "string",
  "csv": "string",
  "count": 0,
  "truncated": true
}

Schema

filenamestringrequired

csvstringrequired

countintegerrequired

truncatedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

POSThttps://hermeticor.com/v1/segments/{id}/export-jobs

Every current member as a CSV file, prepared in the background (poll GET /v1/exports/:id for the download link)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/segments/{id}/export-jobs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

bulk | export

opstringrequired

statusstringrequired

queued | running | completed | failed

progressobjectrequired

Show child parameters

totalintegerrequired

processedintegerrequired

failedintegerrequired

errorstringrequired

downloadUrlstring

failuresFailuresItem[]

Show child parameters

profileIdstringrequired

messagestringrequired

createdAtstringrequired

finishedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

GEThttps://hermeticor.com/v1/segments/{id}/translate

The definition as plain-language lines

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/segments/{id}/translate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "lines": [
    "string"
  ]
}

Schema

linesstring[]required

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

GEThttps://hermeticor.com/v1/segments/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/segments/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

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"
}

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 · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

DELETEhttps://hermeticor.com/v1/segments/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/segments/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

PATCHhttps://hermeticor.com/v1/segments/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

descriptionstring

folderstring

definitionobject

Show child parameters

typestringrequired

group

opstringrequired

and | or

negateboolean

childrenschema0[]required

statusstring

active | archived

starredboolean

tagsstring[]

{
  "name": "string",
  "description": "string",
  "folder": "string",
  "definition": {
    "type": "group",
    "op": "and",
    "negate": true,
    "children": [
      {}
    ]
  },
  "status": "active",
  "starred": true,
  "tags": [
    "string"
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/segments/{id}" \
  -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":[{}]},"status":"active","starred":true,"tags":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/segments/{id}

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/segments/{id}/evaluate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "queued": true
}

Schema

queuedbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/segments/suggest

5XX Default Response

Same as 4XX · GET /v1/segments/suggest

Next part

Updated Nov 8, 2026

Was this page helpful?