Skip to content
API Documents/
/
/
Retrieve segment by ID

Retrieve segment by ID

Request

Retrieve a segment by ID.

Path
idinteger, (int64)required

Segment ID

curl -i -X GET \
  'https://api-cdp.treasuredata.com/entities/segments/{id}'

Responses

Returns a segment by ID

Bodyapplication/vnd.treasuredata.v1+json
dataBatchSegmentJsonApiResource (object) or RealtimeSegmentJsonApiResource (object) or FunnelStageSegmentJsonApiResource (object)required
One of:
includedArray of objects(UserJsonApiResource)required
Response
{
  "data": {
    "id": "string",
    "type": "segment-batch",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ]
}