banners.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:
-
adStatus:
ad's status(set by system)
-
adType:
ad's type
-
bannerName:
Banner's name
-
createDate:
create date
-
clickthruUrl:
Ad's url
-
deleted:
is ad deleted?
-
deleteDate:
ad's delete date
-
description:
Description
-
mobileFinalUrl:
Final URL
-
height:
Banner's height
-
id:
banner id
-
image.id:
Image id
-
image.url:
Image URL
-
image.width:
Image width
-
image.height:
Image height
-
image.size:
Image size
-
imageType:
Image type
-
imageUrl:
(DEPRECATED, always returns empty string, use image.url instead)
-
width:
Banner's width
-
premiseId:
firmy premise ID for ad
-
premiseModeId:
mode ID for firmy premise for ad
-
premiseMode:
mode for firmy premise for ad
-
status:
status of the ad(set by user)
-
sensitivity:
ad's sensitivity
-
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
-
campaign.status:
campaign status
-
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
-
group.status:
group status
-
avgCpc:
Cost per click - average cost for one click
-
avgPos:
Average position in display format
-
clickMoney:
money paid for clicks
-
clicks:
Number of clicks
-
conversions:
Number of conversions
-
conversionValue:
Value of conversions
-
impressionMoney:
money paid for impressions
-
impressions:
Number of impressions
-
totalMoney:
total money paid(for clicks and impressions)
-
transactions:
Number of transactions
-
missImpressions:
missed impressions
-
underLowerThreshold:
missed impressions because of low cpc
-
exhaustedBudget:
missed impressions because of exhausted budget
-
schedule:
banner schedule for next week
-
scheduleEnabled:
banner has schedule
-
stoppedBySchedule:
missed impressions because of banner schedule
-
underForestThreshold:
missed impressions because of low relevancy
-
exhaustedBudgetShare:
missed impressions because of exhausted shared budget
-
ctr:
Click Through Rate
-
pno:
Cost Of Sale(COS)
-
ish:
not missed impressions percentage in fulltext network
-
ishContext:
not missed impressions percentage on context network
-
ishSum:
not missed impressions percentage in both networks
|
|
) |
|
|
|
} |
|
|
Response
| struct |
{ |
|
| array |
report ( |
|
| struct |
{ |
|
| array |
stats ( |
statistics
|
| struct |
{ |
|
| int |
avgCpc |
(optional) Cost per click - average cost for one click
|
| double |
avgPos |
(optional) Average position in display format
|
| int |
clickMoney |
(optional) money paid for clicks
|
| int |
clicks |
(optional) Number of clicks
|
| int |
conversions |
(optional) Number of conversions
|
| int |
conversionValue |
(optional) Value of conversions
|
| datetime |
date |
Start date of given period
|
| string |
devicePhone |
(optional) Statistics for phone
|
| string |
deviceTablet |
(optional) Statistics for tablet
|
| string |
deviceDesktop |
(optional) Statistics for desktop
|
| string |
deviceOther |
(optional) Statistics for other devices
|
| int |
impressionMoney |
(optional) money paid for impressions
|
| int |
impressions |
(optional) Number of impressions
|
| int |
totalMoney |
(optional) total money paid(for clicks and impressions)
|
| int |
transactions |
(optional) Number of transactions
|
| int |
missImpressions |
(optional) missed impressions
|
| int |
underForestThreshold |
(optional) missed impressions because of low relevancy
|
| int |
underLowerThreshold |
(optional) missed impressions because of low cpc
|
| int |
exhaustedBudget |
(optional) missed impressions because of exhausted budget
|
| int |
stoppedBySchedule |
(optional) missed impressions because of campaign schedule
|
| int |
exhaustedBudgetShare |
(optional) missed impressions because of exhausted shared budget
|
| int |
ctr |
(optional) Click Through Rate
|
| int |
pno |
(optional) Cost Of Sale(COS)
|
| int |
ish |
(optional) not missed impressions percentage in fulltext network
|
| int |
ishContext |
(optional) not missed impressions percentage on context network
|
| int |
ishSum |
(optional) not missed impressions percentage in both networks
|
|
} |
|
|
|
) |
|
|
| datetime |
createDate |
(optional) create date
|
| datetime |
deleteDate |
(optional) delete date
|
| string |
creative1 |
(optional) creative1
|
| string |
creative2 |
(optional) creative2
|
| string |
creative3 |
(optional) creative3
|
| string |
clickthruUrl |
(optional) URL to which is the user redirected after clicking on the displayed URL
|
| string |
headline1 |
(optional) Headline 1
|
| string |
headline2 |
(optional) Headline 2
|
| string |
description |
(optional) Description
|
| string |
path1 |
(optional) Path 1
|
| string |
path2 |
(optional) Path 2
|
| string |
bannerName |
(optional) Banner's name
|
| struct |
image { |
(optional)
|
| int |
id |
(optional) image id
|
| int |
width |
(optional) image width
|
| int |
height |
(optional) image height
|
| int |
size |
(optional) image size
|
| string |
url |
(optional) image url
|
|
} |
|
|
| int |
premiseId |
(optional) (can be null) firmy premise ID for ad
|
| int |
premiseModeId |
(optional) (can be null) mode ID for firmy premise for ad
|
| string |
premiseMode |
(optional) (can be null) mode for firmy premise for ad:
-
disabled:
Assigned premise is not shown
-
one:
Premise specified in premiseId is shown
-
nearest:
Client nearest premise is shown
-
inherit:
Premise specified in its campaign is shown
|
| string |
finalUrl |
(optional) Final URL
|
| bool |
deleted |
(optional) is ad deleted?
|
| string |
status |
(optional) status of the ad(set by user)
|
| string |
adStatus |
(optional) ad's status(set by system)
|
| string |
adType |
(optional) ad's type
|
| string |
trackingTemplate |
(optional) Tracking template
|
| string |
sensitivity |
(optional) erotic sensitivity of ad
|
| string |
imageType |
(optional) Image Type
|
| 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
|
|
} |
|
|
| array |
schedule ( |
(optional) Delivery schedule of banner. Array of 7 days, week starts at monday.
|
) |
|
|
| bool |
scheduleEnabled |
(optional) Banner has schedule?
|
|
} |
|
|
|
) |
|
|
| 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:
banner_access_deniedcache_id_not_existuser_access_deniedwrong_param_value
