Get a specific segment

Retrieves details of a specific segment by segmentId

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

segmentId

number

required

ID of the segment to be retrieved

Response

200 - application/json

_id

string

fabric internal database ObjectId of the record

createdAt

string

Creation date of the record

deleted

boolean

true: segment is deleted<br /> false: segment is not deleted

name

string

Name of the segment

segmentId

number

System generated unique ID of the Segment

updatedAt

string

Last updated date of the record

value

string[]

Array of segment values