---
title: "Get segmentation"
method: GET
path: "/v2/segmentation/{segmentation_id}"
tags: ["Segmentation"]
---

# Get segmentation

`GET /v2/segmentation/{segmentation_id}`

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

## Path parameters

- `segmentation_id` integer, required

## Query parameters

- `apiToken` string, nullable

## Headers

- `x-api-token` string, nullable

## Response `200`

Successful Response

- Segmentation
  - `segmentationId` integer, required — Unique id of the segmentation.
  - `segments` Segment[], required — Resulting segments. Empty while `status` is `IN_PROGRESS`.
    - `segmentId` integer, required — Unique id of the segment within the segmentation.
    - `name` string, required — Human-readable label describing the segment.
    - `domains` string[], required — Domains of the companies assigned to this segment.
    - `companyCount` integer, required — Number of companies in the segment.
    - `traits` ScoringFeature[], nullable — Company attributes that most define the segment, each with the matched value and a relative score. Present when the segmentation was run with scoring features.
      - `featureName` string, required — Feature that contributed to score
      - `featureValue` string, required — Specific value that matched
      - `score` number, required — Boost contribution
    - `crmMetrics` SegmentCrmMetrics
      - `averageDealValue` number, nullable, required — Average deal value for the segment, from your connected CRM.
      - `averageTimeToClose` number, nullable, required — Average time to close in days, from your connected CRM.
      - `winRate` number, nullable, required — Win rate for the segment (0-1), from your connected CRM.
      - `untouchedCount` integer, nullable, required — Companies in the segment you have no CRM activity with yet.
    - `lookalikeCount` integer, nullable — Estimated number of lookalike companies for this segment.
  - `status` 'IN_PROGRESS' | 'SUCCESSFUL' | 'FAILED', required
  - `totalAddressableMarket` integer, nullable — Estimated number of lookalike companies across all segments.
  - `totalUntouched` integer, nullable — Companies in the addressable market you have no CRM activity with yet.

## Other responses

- `400` — Bad Request
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/ocean/apis/ocean-io-api-documentation.md) · [All operations](https://skmtc.dev/ocean/apis/ocean-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ocean/ocean-io-api-documentation/revisions/505121e48722/schema)