Retrieve segment by ID

Retrieve a segment by ID.

Request

path Parameters

required

integer <int64>

Segment ID

Responses

200

Returns a segment by ID

get/entities/segments/{id}

Request samples

curl
JS

Response samples

application/vnd.treasuredata.v1+json

{"data": {"id": "string",
"type": "segment-batch",
"attributes": {"audienceId": "string",
"name": "string",
"description": "string",
"population": 0,
"numSyndications": 0,
"rule": {"conditions": [{"conditions": [{"exclude": null,
"id": null,
"type": null
}
],
"description": "string",
"expr": "string",
"type": "Or"
}
],
"expr": "string",
"limit": {"number": 0,
"orderColumns": [{"column": "string",
"order": "ascending",
"type": "Column"
}
],
"type": "Count"
},
"type": "Or"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"countPopulation": true,
"segmentInsightDashboardId": 0,
"isEmptyRule": true
},
"relationships": {"parentFolder": {"data": {"id": "string",
"type": "folder-segment"
}
},
"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
},
"included": [{"id": "string",
"type": "user",
"attributes": {"tdUserId": "string",
"name": "string"
}
}
]
}