retargeting.lists.get
Get retargeting lists by list of IDs.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
listIds ( |
|
|
int
|
|
|
(optional) Id of retargeting list
|
|
) |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see below)
|
| string |
statusMessage |
Status code description
|
| struct |
diagnostics { |
(optional) Additional information about processed request (see below)
|
} |
|
|
| string |
session |
(optional) Refreshed session
|
| array |
lists ( |
Array of retargeting lists
|
| struct |
{ |
|
| int |
listId |
Id of retargeting list
|
| struct |
attributes { |
|
| string |
name |
Name of retargeting list.
|
| string |
status |
Status:
-
active:
Active retargeting list
-
paused:
Paused retargeting list
|
| int |
retargetingId |
Retargeting code
|
| int |
membership |
Duration in days user will be in this
|
| bool |
useHistoricData |
Include users by url requests requested
|
| bool |
takeAllUsers |
Include all url requests to retargeting list.
|
| int |
users |
Number of users in list
|
| string |
description |
Description of Retargeting list
|
| datetime |
createDate |
Date of creating retargeting list
|
| datetime |
suspendDate |
Date of closing retargeting list
|
| datetime |
deleteDate |
Date of deleting retargeting list
|
| bool |
deleted |
Whether list was deleted
|
|
} |
|
|
| array |
conditionGroups ( |
Groups of conditions
|
| struct |
{ |
|
| int |
conditionGroupId |
Id of group of conditions
|
| array |
conditions ( |
List of Conditions (in that group)
|
| struct |
{ |
|
| int |
conditionId |
Id of condition
|
| string |
type |
Type of condition:
-
contains:
contains
-
not_contains:
not contains
-
equals:
equals
-
not_equals:
not equals
-
starts:
starts
-
not_starts:
not starts
-
ends:
ends
-
not_ends:
not ends
|
| string |
value |
Value of condition (ex. part of url)
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
retargeting_list_not_existretargeting_list_not_founduser_access_denied
