API call to check get the list of the recommended segments (/ai/segment/recommend).
IMPORTANT: The AI segment recommendation are up to 10 elements, meaning that sometime it might happen that the generated segments are less than 10
The user must be authenticated and have read permissions to the siteGroup. The customer must have the AI feature enabled to generate segment descriptions.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
SiteGroupId used to generate the segments recommendations |
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
Array of Objects |
List of the segments generated |
Response Object
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
AI generated name for the recommended segment |
|
|
String |
AI generated description for the recommended segment |
|
|
Object |
AI generated filter for the recommended segment |
Examples (response trimmed for the sake of the example)
$ python cx.py /ai/segment/recommend/read '{"siteGroupId": "1234567890"}'
{
"segments": [
{
"name": "High-Intent Property Buyers",
"description": "Users actively searching for property with high-value price ranges who are likely to convert to premium subscriptions for property insights and market data",
"filter": {
... // filter definition here
}
},
... // The remaining segments here
{
"name": "Business Professional Sports Enthusiasts",
"description": "Business professionals with high purchasing power who are active sports consumers, particularly cycling and Formula 1 - premium demographic for business and sports content subscriptions",
"filter": {
... // filter definition here
}
}
]
}