API call to check the status of the segment recommendations (/ai/segment/recommend).
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 |
|---|---|---|
|
|
String |
One of |
|
|
String |
The time when the |
Status definitions
|
Status |
Description |
|---|---|
|
|
The generation of segments have been completed successfully |
|
|
The generation of segments is under processing |
|
|
The generation of segments didn't manage to find any recommendations |
|
|
The generation of segments haven't been requested yet |
Examples
$ python cx.py /ai/segment/recommend/status '{"siteGroupId": "1234567890"}'
{
"status": "SUCCESS",
"lastStatusTime": "2026-03-01T12:00:00"
}