Get a Segment Type (Hub)

[This topic is pre-release documentation and is subject to change.]

Gets the specified Segment type definition.

Request

The request is constructed as follows:

HTTP Verb Request URI
GET <Hub-endpoint>/manage/model/segments/<segmentName>?api-version=2017-04-26&&locale=<locale-code>

URI Parameters

URI Parameter Required Description
Hub-endpoint Yes The base URL for your Customer Insights Hub
segmentName Yes The name of the Segment definition to retrieve
locale-code No The localization code to apply to any returned properties. If no locale code is specified, then 'en-us' is used as default.

Response

The response includes a standard HTTP status code, a set of standard response headers, and a response body.

Response Body

Upon success, contains the requested Segment type definition.

Status Code

  • 200 (OK) - Segment was returned successfully.
  • 403 (Forbidden) - Operation was blocked, usually because the Segmentation feature flag is disabled.
  • 404 (Not Found) - Specified segment name was not found.