v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Segmentation

Get segmentation

Retrieve a segmentation by its id, including its segments, traits, and CRM metrics once status is SUCCESSFUL.

get/v2/segmentation/{segmentation_id}

Path parameters

segmentation_idinteger required

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Response

Successful Response

segmentationIdinteger required

Unique id of the segmentation.

status'IN_PROGRESS' | 'SUCCESSFUL' | 'FAILED' required

totalAddressableMarketinteger nullable

Estimated number of lookalike companies across all segments.

totalUntouchedinteger nullable

Companies in the addressable market you have no CRM activity with yet.

Example response

{
  "segmentationId": 12345,
  "segments": [
    {
      "segmentId": 1,
      "name": "Enterprise data platforms",
      "domains": [
        "snowflake.com",
        "datadoghq.com"
      ],
      "companyCount": 2,
      "crmMetrics": {
        "averageDealValue": 48000,
        "averageTimeToClose": 64,
        "winRate": 0.31,
        "untouchedCount": 12
      },
      "lookalikeCount": 1840
    }
  ],
  "totalAddressableMarket": 3200,
  "totalUntouched": 27
}