curl --request GET \
--url https://api.topsort.com/public/v1/segment-service/segments \
--header 'Authorization: Bearer <token>'{
"segments": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"total": 123,
"config": {
"type": "static"
}
}
]
}Retrieve a list of segments.
curl --request GET \
--url https://api.topsort.com/public/v1/segment-service/segments \
--header 'Authorization: Bearer <token>'{
"segments": [
{
"name": "<string>",
"description": "<string>",
"id": "<string>",
"total": 123,
"config": {
"type": "static"
}
}
]
}A valid API key generated in Topsort's UI.
Successful Response
List of segments.
Show child attributes
Name of the segment.
64Description of the segment.
400ID of the segment.
User count of the segment.
Configuration of the segment.
Show child attributes
Type of the dynamic segment config.
"dynamic"Definition of the dynamic segment config.
Show child attributes
List of behaviors.
1 - 3 elementsShow child attributes
Type of the action.
impressions, clicks, purchases List of behavior parameters.
1 - 3 elementsLogic of the behavior.
and, not Frequency definition of the action.
Show child attributes
Number of times the action occurs.
x >= 1Operator of the frequency: (eq: equals, gt: greater than, gte: greater than or equal to, lt: less than, lte: less than or equal to).
eq, gt, gte, lt, lte Was this page helpful?