campaigns.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.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| string |
reportId |
filter id
|
| struct |
displayOptions { |
Customize output
|
| bool |
allowEmptyStatistics |
(optional) Return empty statistics [default: false]
|
| array |
displayColumns ( |
(optional) show following entity attributes
|
|
string
|
|
|
column name:
-
actualClicks:
Actual clicks
-
adSelection:
Ad selection method
-
automaticLocation:
Is automatic location enabled
-
budget.colorCodeId:
Budget's color
-
budget.dayBudget:
Day budget value
-
budget.deleted:
Is budget deleted?
-
budget.deleteDate:
When was day budget deleted
-
budget.id:
Budget's id
-
budget.name:
Budget's name
-
context:
is it context campaign?
-
contextNetwork:
targeted context networks
-
createDate:
create date
-
deleted:
is campaign deleted ?
-
deleteDate:
Deletion date
-
defaultBudgetId:
Default budget id.
-
devicesPriceRatio:
Specific ratio of max CPC/CPT for target device
-
endDate:
Campaign end date
-
excludedSearchServices:
Search services, where ads from this campaign will not be displayed
-
excludedUrls:
URLs of web sites, where ads from this campaign will not be displayed (if context placement is enabled)
-
exhaustedTotalBudget:
If campaign total budget is set, how much of it is exhausted (in halers)
-
fulltext:
is it fulltext campaign?
-
id:
campaign id
-
name:
Campaign name
-
paymentMethod:
Payment method
-
phone.number:
Phone number
-
phone.statusId:
Phone number status id
-
phone.status:
Phone number status
-
premises.id:
campaign premises
-
schedule:
campaign schedule for next week
-
scheduleEnabled:
campaign has schedule
-
startDate:
Campaign start date
-
status:
campaign status
-
regions.id:
Predefined region id for geotargeting
-
regions.parentId:
Superior region id
-
regions.name:
Predefined region name
-
totalClicks:
Total allowed clicks for campaign
-
totalClicksFrom:
Date from the total budget for clicks is counted
-
totalBudgetFrom:
Date from the total budget for money is counted
-
type:
campaign type
-
totalBudget:
Campaign total budget (if set; in halers)
-
videoFormat:
Video format
-
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 (obsolete)
-
exhaustedBudget:
missed impressions because of exhausted budget
-
stoppedBySchedule:
missed impressions because of campaign schedule
-
underForestThreshold:
missed impressions because of low rank
-
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
-
avgCpt:
average Cost per thousand - cost per thousand impressions
|
|
) |
|
|
| bool |
auctionTypeBreakdown |
(optional) Breakdown of statistics of zbozi auction types, only in zbozi campaigns [default: false]
|
| bool |
websiteBreakdown |
(optional) Breakdown of statistics of zbozi placements, only in zbozi campaigns [default: false]
|
|
} |
|
|
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 rank
|
| int |
underLowerThreshold |
(optional) missed impressions because of low cpc (obsolete)
|
| 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
|
| double |
avgCpt |
(optional) average Cost per thousand - cost per thousand impressions
|
| struct |
auctionTypeBreakdown { |
(optional) Statistics for zbozi campaigns, broken down by auction type
|
| struct |
detail { |
structure of requested statistic values for auction type detail
|
|
|
} |
|
|
| struct |
offer { |
structure of requested statistic values for auction type offer
|
|
|
} |
|
|
| struct |
price { |
structure of requested statistic values for auction type price
|
|
|
} |
|
|
|
} |
|
|
| struct |
websiteBreakdown { |
(optional) Statistics for zbozi campaigns, broken down by website
|
| struct |
seznam { |
structure of requested statistic values for website seznam
|
|
|
} |
|
|
| struct |
zbozi { |
structure of requested statistic values for website zbozi
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
) |
|
|
| int |
actualClicks |
(optional) Actual clicks
|
| string |
adSelection |
(optional) Ad selection method
|
| bool |
automaticLocation |
(optional) Is automatic location enabled.
|
| bool |
context |
(optional) is it context campaign?
|
| string |
contextNetwork |
(optional) Name of targeted context networks
|
| datetime |
createDate |
(optional) create date
|
| bool |
deleted |
(optional) is campaign deleted ?
|
| datetime |
deleteDate |
(optional) Deletion date
|
| int |
defaultBudgetId |
(optional) Default budget id.
|
| struct |
devicesPriceRatio { |
(optional) Specific ratio of max CPC/CPT for target device
|
| int |
desktop |
Desktop/Notebook devices
|
| int |
mobile |
Smartphones/Mobile devices
|
| int |
tablet |
Tablet devices
|
|
} |
|
|
| datetime |
endDate |
(optional) Campaign end date
|
| int |
exhaustedDayBudget |
(optional) How much of the day budget is already exhausted
|
| int |
exhaustedTotalBudget |
(optional) Exhausted total budget
|
| bool |
fulltext |
(optional) is it fulltext campaign?
|
| int |
id |
(optional) campaign id
|
| string |
name |
(optional) Campaign name
|
| string |
paymentMethod |
(optional) Payment method
|
| datetime |
startDate |
(optional) Campaign start date
|
| string |
status |
(optional) campaign status
|
| int |
totalBudget |
(optional) Total allowed budget for campaign
|
| datetime |
totalBudgetFrom |
(optional) Date from which total money budget is counting
|
| int |
totalClicks |
(optional) Total allowed clicks for campaign
|
| datetime |
totalClicksFrom |
(optional) Date from which total click budget is counting.
|
| string |
type |
(optional) campaign type
|
| string |
videoFormat |
(optional) video format
|
| struct |
budget { |
(optional)
|
| int |
dayBudget |
(optional) Day budget value
|
| bool |
deleted |
(optional) Is budget deleted?
|
| datetime |
deleteDate |
(optional) When was day budget deleted
|
| int |
colorCodeId |
(optional) Budget's color
|
| string |
name |
(optional) Budget's name
|
|
} |
|
|
| struct |
phone { |
(optional)
|
| string |
number |
(optional) Actual phone number
|
| int |
statusId |
(optional) Phone number status id
|
| string |
status |
(optional) Actual phone number status
|
|
} |
|
|
| array |
excludedSearchServices ( |
(optional) Search services, where ads from this campaign
|
|
int
|
|
|
(optional) Search service id (as retrieved from listSearchServices())
|
|
) |
|
|
| array |
excludedUrls ( |
(optional) URLs of web sites, where ads from this campaign
|
|
|
) |
|
|
| array |
regions ( |
(optional) Geotargeting
|
| struct |
{ |
|
| int |
id |
(optional) Predefined region id (only for type=predefined)
|
| int |
parentId |
(optional) Superior region id
|
| string |
name |
(optional) Predefined region name
|
|
} |
|
|
|
) |
|
|
| array |
schedule ( |
(optional) Spending schedule of campaign. Array of 7 days, week starts at monday.
|
) |
|
|
| bool |
scheduleEnabled |
(optional) Campaign has schedule?
|
| struct |
premises { |
(optional) Connection with Firmy.cz
|
| int |
id |
(optional) (can be null) Connection with Firmy.cz
|
|
} |
|
|
|
} |
|
|
|
) |
|
|
| 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:
cache_id_not_existcampaign_access_denieduser_access_deniedwrong_param_value
