client.stats
Get statistics for account.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) User ID
|
|
} |
|
|
| struct |
params { |
|
| datetime |
dateFrom |
Start date (YYYY-MM-DD)
|
| datetime |
dateTo |
End date (YYYY-MM-DD)
|
| string |
granularity |
Granularity:
-
total:
Sum all stats together
-
daily:
Split stats by day
-
weekly:
Split stats by week
-
monthly:
Split stats by month
-
quarterly:
Split stats by quarter
-
yearly:
Split stats by year
|
| bool |
includeFulltext |
(optional) Include statistics from fulltext [default: true]
|
| bool |
includeContext |
(optional) Include statistics from context [default: true]
|
| bool |
splitByConversions |
(optional) Split report by specified conversions (excludes: splitByRetargeting) [default: false]
|
|
} |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
report ( |
Statistical report
|
| struct |
{ |
|
| datetime |
date |
Start date of given period (depends on granularity)
|
| int |
impressions |
Number of impressions
|
| int |
clicks |
Number of clicks
|
| double |
ctr |
Click ratio - how much clicks per one impression (%)
|
| int |
cpc |
Cost per click - average cost per one click
|
| int |
price |
Total price paid for displaying ads (for clicks or impressions)
|
| double |
avgPosition |
Average position of ad in display format
|
| int |
conversions |
Number of conversions (how many times user made an order)
|
| double |
conversionRatio |
How many conversions per one click (%)
|
| int |
conversionAvgPrice |
Price of one conversion
|
| int |
conversionValue |
Value of conversions
|
| int |
conversionAvgValue |
Average value of conversion
|
| double |
conversionValueRatio |
Value / price ratio (%)
|
| int |
transactions |
Number of transactions
|
| int |
transactionAvgPrice |
Price of one transaction
|
| int |
transactionAvgValue |
Average value of one transaction
|
| double |
transactionAvgCount |
Average number of transactions per conversion
|
| array |
conversionList ( |
(optional) Splitted statistics by conversion
|
| struct |
{ |
|
| string |
name |
Conversion name
|
| string |
type |
Conversion type
|
| int |
price |
Conversion total price
|
| int |
conversions |
Number of conversions
|
| int |
conversionValue |
Value of conversions
|
| int |
conversionAvgValue |
Average value of one conversion
|
| int |
conversionAvgPrice |
Average price of one conversion
|
| double |
conversionValueRatio |
Value / price ratio (%)
|
| int |
transactions |
Number of transactions
|
| int |
transactionAvgPrice |
Average price of transaction
|
| int |
transactionAvgValue |
Average value of transaction
|
| int |
transactionAvgCount |
Average number of transactions per conversion
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
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:
