List all segments. An optional 'excludeReplacedSegments' parameter is used to get the list of segments which has not yet been replaced (determined by segment lineage entries) and can be queried from the table. The value is false by default.

curl --request GET \
  --url https://dev.startree.ai/segments/{tableName} \
  --header 'Authorization: <api-key>'

[
  {}
]

GET

segments

{tableName}

curl --request GET \
  --url https://dev.startree.ai/segments/{tableName} \
  --header 'Authorization: <api-key>'

[
  {}
]

Authorizations

Authorization

string

header

required

The format of the key is "Basic <token>" or "Bearer <token>"

Path Parameters

tableName

string

required

Name of the table

Query Parameters

type

string

OFFLINE|REALTIME

excludeReplacedSegments

string

Whether to exclude replaced segments in the response, which have been replaced specified in the segment lineage entries and cannot be queried from the table

startTimestamp

string

Start timestamp (inclusive)

endTimestamp

string

End timestamp (exclusive)

excludeOverlapping

boolean

default:false

Whether to exclude the segments overlapping with the timestamps, false by default

Response

200 - application/json

successful operation

{key}

string[]

Get the metadata for a segment Delete the list of segments provided in the queryParam else all segments

⌘I