retargeting.group.negative.createReport
Create statistic report for retargeting.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| struct |
restrictionFilter { |
|
| array |
ids ( |
(optional) display retargetings by given ids
|
|
|
) |
|
|
| bool |
isDeleted |
(optional) return deleted/undeleted. If unassigned returns both.
|
| array |
type ( |
(optional) return only retargetings with following types:
|
|
string
|
|
|
types:
-
list:
list
-
combination:
combination
-
dynamic_list:
dynamic list
|
|
) |
|
|
| array |
status ( |
(optional) return only retargetings with following states:
|
|
string
|
|
|
states:
-
active:
active
-
noactive:
suspended by system
-
suspend:
suspended by user
|
|
) |
|
|
| struct |
group { |
(optional) filters for superior group
|
| array |
ids ( |
(optional) display insterests from next groups (excludes: names)
|
|
|
) |
|
|
| array |
names ( |
(optional) definition of searching in groups names
|
| struct |
{ |
|
| string |
operator |
comparison for following operators:
|
|
} |
|
|
|
) |
|
|
| array |
mixedStatus ( |
(optional) return only insterests with following states of their groups:
|
|
string
|
|
|
states:
-
active:
active
-
noactive:
suspended by system
-
suspended:
suspended by user
-
deleted:
deleted
|
|
) |
|
|
| array |
status ( |
(optional) return only insterests with following states of their groups:
|
|
string
|
|
|
states:
-
active:
active
-
noactive:
suspended by system
-
suspend:
suspended by user
|
|
) |
|
|
| bool |
isDeleted |
(optional) return deleted/undeleted. If unassigned returns both.
|
|
} |
|
|
| struct |
campaign { |
(optional) filters for superior campaign
|
| array |
ids ( |
(optional) display insterests from next campaigns (excludes: names)
|
|
|
) |
|
|
| array |
names ( |
(optional) definition of searching in campaign names
|
| struct |
{ |
|
| string |
operator |
comparison for following operators:
|
|
} |
|
|
|
) |
|
|
| array |
mixedStatus ( |
(optional) return only insterests with following states of their campaigns
|
|
string
|
|
|
allowed states:
-
active:
active
-
active-exhausted_day_budget:
exhausted day budget
-
active-expired_budget:
expired budget
-
active-expired_clicks:
max number of clicks has been reached
-
active-expired_time:
outside time plan
-
active-low_budget:
low budget
-
active-waiting:
waiting for confirmation
-
suspended:
suspended by user
-
deleted:
deleted
|
|
) |
|
|
| array |
status ( |
(optional) return only insterests with following states of their campaigns:
|
|
string
|
|
|
states:
-
active:
active
-
noactive:
suspended by system
-
suspend:
suspended by user
|
|
) |
|
|
| bool |
isDeleted |
(optional) return deleted/undeleted. If unassigned returns both.
|
|
} |
|
|
|
} |
|
|
Response
| struct |
{ |
|
| int |
reportId |
id of report
|
| long |
totalCount |
number of entities
|
| string |
statusMessage |
verbal description of return code
|
| string |
session |
Refreshed session
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
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:
