v1

latestOpenAPI 3.1.02026-08-04282319386.0 KB

segment

Get Segment

Get segment

get/segment/{segment_id}

Path parameters

segment_idstring required

Response

Successful Response

idstring

ID of this object.

_markedForDeletionboolean

marked if record has been soft-deleted.

namestring required

The name of the segment.

descriptionstring

description of the segment.

ownerstring required

The owner of the segment.

teamIdstring required

The team ID associated with the segment.

projectIdstring required

The ID of the project associated with the segment.

chatRecordIdstring nullable

The ID of the chat record associated with the segment.

state'PENDING' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'UNKNOWN_TIMEOUT'

Celery task status enum. Update apps/web-backend-api/src/types/TaskStatusEnum.ts if you update this enum.

segmentSqlstring required

The SQL query defining the segment.

regionstring required

The region for which the segment was built.

wavestring required

The wave for which the segment was built.

defaultCompareSegmentIdstring required

The default compare segment ID.

saved_to_dbboolean required

Whether the segment is saved to the database.

llm_generatedboolean

Whether the segment was generated by LLM.

isGlobalSegmentboolean

Whether the segment is global or pre-generated.

isSavedByUserboolean

Whether the segment was saved by the user.

segmentInsightsobject

Insights related to the segment.

bannerImagePathstring

storage path for the segment banner.

importedboolean

Whether the segment was imported.

num_rowsinteger

The number of rows in the segment.

last_refreshedstring date-time nullable

datetime object representing when this segment was last refreshed.