OCocean
Segmentation

Attribute domains to segments

Changed on

Assign each input domain to the closest segment in a segmentation, with a 0-1 match score. The segmentation must have completed successfully first.

post/v2/segmentation/{segmentation_id}/attribute-domains

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/segmentation/{segmentation_id}/attribute-domains
  • Auth
    none declared

Path parameters

segmentation_idinteger required

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

domainsstring[] required

Domains to attribute (max 1000).

Example request

{
  "domains": [
    "domain1.com",
    "domain2.com"
  ]
}

Response

Successful Response

totalRequestedinteger required

Total number of domains requested.

totalAttributedinteger required

Number of domains attributed to a segment. Excludes unmatched domains and domains that couldn't be evaluated.

Example response

{
  "results": [
    {
      "domain": "domain1.com",
      "segmentId": 42,
      "score": 0.91
    }
  ],
  "totalRequested": 3,
  "totalAttributed": 2
}

Changes