API call to retrieve the lookalike configuration for a segment.
The user must be authenticated and have read permissions to the site group.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
id |
String |
No |
Return the lookalike configuration for the given id. |
|
siteGroupId |
String |
No |
Return all lookalike configurations for the given site group identifier. |
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
segments |
Array of objects |
Array of lookalike segment objects. |
An lookalike segment object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
id |
String |
The identifier for the audience segment. |
|
siteGroupId |
String |
The site group identifier to which this audience segment belongs. |
|
active |
Boolean |
True if the segment has enabled lookalike modelling. |
|
fraction |
Double |
The fraction of the population in the site group which should be annotated as lookalikes. |
|
negatives |
Array of String |
Array of segment ids representing the opposite of this segment, which we should train the model against. Included in response only if it was specified to non empty value in update request . |
Examples
$ python cx.py /segment/lookalike/read '{"id":"1234"}'
{
"segments": [
{
"id": "1234",
"siteGroupId": "5678",
"active": true,
"fraction": 0.05
"negatives": ["3456"]
}
]
}