Search profiles in segment using API
Learn more about the Segmentation Api to search for profiles.
This Segments API will search for profiles in a segment.
Request
POST /api/{tenantId}/segments/{id}/entities/scan| Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization
| Yes | Information about authentication access token in the format "Bearer <accessToken>". For more information, see Authentication API. |
| Query | sort | No | Denotes the field that is used to sort the results. |
| order | No | Indicates whether the segments are sorted in ascending or descending order. | |
| filter | No | The Search API filter conditions against the segment fields. | |
| offset | No | The pagination offset. | |
| max | No | The maximum results to be displayed in the response. | |
Request body for first page
The request body for the first page should be empty.
Response
{
"cursor" : {
"value" : "cXVlcnlBbmRGZXRjaDsxOzE0NDI3OmpzdTdBNGNnUWU2YlBqc1JQbTlNbnc7MDs="
},
"objects" : [
{
"uri" : "entities/0Fglh8Z",
...
},
{
"uri" : "entities/0Fglh11",
...
},
...
]
}Request body for next pages
{
"cursor": {
"value": "cXVlcnlBbmRGZXRjaDsxOzE0NDI3OmpzdTdBNGNnUWU2YlBqc1JQbTlNbnc7MDs="
}
}
Response for last page do not contain objects:
{
"cursor" : {
"value" : "cXVlcnlBbmRGZXRjaDsxOzE0NDI3OmpzdTdBNGNnUWU2YlBqc1JQbTlNbnc7MDs="
},
"objects" : []
}