retargeting.group.negative.readReport
Return statistics from report specified by id. Amount of data that you can get is limited.
Amount of data is counted as number_of_wanted_entities * number_of_periods_for_one_entity.
You can get data limit by method api.limits in parameter statsDataLimit.
Method can also return other entity attributes(similar to list(...) method),
however this can slow down the report.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| string |
reportId |
report id
|
| struct |
displayOptions { |
Customize output
|
| bool |
allowEmptyStatistics |
(optional) Return empty statistics [default: false]
|
| array |
displayColumns ( |
show following entity attributes
|
|
string
|
|
|
column name:
-
id:
retargeting list id
-
isCombination:
is combination
-
name:
name
-
campaign.actualClicks:
Actual clicks for campaign
-
campaign.createDate:
Campaign's create date
-
campaign.deleteDate:
Campaign's Deletion date
-
campaign.deleted:
Is campaign deleted?
-
campaign.endDate:
Campaign's end date
-
campaign.id:
Campaign's id
-
campaign.name:
Campaign's name
-
campaign.startDate:
Campaign's start date
-
campaign.totalBudgetFrom:
Date from which total money budget is counting.
-
campaign.totalClicksFrom:
Date from which total click budget is counting.
-
campaign.totalClicks:
Total clicks for campaign
-
group.id:
Group's id
-
group.name:
Group's name
-
group.deleted:
Is group deleted?
-
group.createDate:
Group's create date
-
group.deleteDate:
Group's delete date
-
group.maxCpc:
maximum cpc for group's targeting
-
group.maxCpt:
maximum cpt(Cost per Thousand) for group's targeting
|
|
) |
|
|
|
} |
|
|
Response
| struct |
{ |
|
| array |
report ( |
|
| struct |
{ |
|
| int |
id |
(optional) retargeting id
|
| string |
name |
(optional) Name of retargeting list.
|
| bool |
isCombination |
(optional) Bool if retargeting list is combination
|
| struct |
group { |
(optional)
|
| int |
id |
(optional) group id
|
| string |
name |
(optional) group name
|
| bool |
deleted |
(optional) is group deleted?
|
| datetime |
createDate |
(optional) create date
|
| datetime |
deleteDate |
(optional) delete date
|
| int |
maxCpc |
(optional) maximum cpc for group's targeting
|
| int |
maxCpt |
(optional) maximum cpt(Cost per Thousand) for group's targeting
|
|
} |
|
|
| struct |
campaign { |
(optional)
|
| int |
id |
(optional) campaign id
|
| string |
name |
(optional) Campaign name
|
| int |
totalClicks |
(optional) Total clicks
|
| int |
actualClicks |
(optional) Actual clicks
|
| bool |
deleted |
(optional) is campaign deleted ?
|
| datetime |
startDate |
(optional) Campaign start date
|
| datetime |
endDate |
(optional) Campaign end date
|
| datetime |
totalBudgetFrom |
(optional) Date from which total money budget is counting.
|
| datetime |
totalClicksFrom |
(optional) Date from which total click budget is counting.
|
| datetime |
createDate |
(optional) create date
|
| datetime |
deleteDate |
(optional) Deletion date
|
|
} |
|
|
|
} |
|
|
|
) |
|
|
| int |
reportId |
id of report
|
| 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:
