v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB

Segmentation

Create segmentation

Create a new segmentation from a list of company domains. Runs asynchronously — poll Get Segmentation until status is SUCCESSFUL to read the resulting segments.

post/v2/segmentation

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

domainsstring[] required

Company domains to segment. Provide a representative set of the companies you want to group, typically your customers or best-fit accounts.

leadScoringFeaturesstring[] nullable

Company attributes to consider when grouping and scoring companies (for example industries, technologies, company_size). Omit to use the default feature set.

numberOfSegmentsModeinteger nullable

Bias toward fewer or more segments. Omit to let the service choose the number that best fits the data.

positiveDomainsstring[] nullable

Companies that are a good fit. The segmentation leans toward similar companies.

negativeDomainsstring[] nullable

Companies that are a poor fit. The segmentation leans away from similar companies.

Example request

{
  "domains": [
    "stripe.com",
    "twilio.com",
    "datadoghq.com",
    "snowflake.com"
  ],
  "leadScoringFeatures": [
    "industries",
    "technologies",
    "company_size"
  ],
  "positiveDomains": [
    "stripe.com"
  ],
  "negativeDomains": [
    "tinyunknown.io"
  ]
}

Response

Successful Response

segmentationIdinteger required

Unique id of the segmentation. Use it to poll for results with the get segmentation endpoint.

Example response

{
  "segmentationId": 12345
}