Sklik API

Productsets

productSets.readReport

Return statistics from report specified by id

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) Managed user ID
}
string reportId report id
struct displayOptions { Customize output
int offset offset
int limit count of items
bool allowEmptyStatistics (optional) Return empty statistics [default: false]
array displayColumns ( (optional) show following entity attributes
string column name:
  • avgCpc: Cost per click - average cost for one click
  • avgPos: Average position in display format
  • campaign.id: Campaign's id
  • campaign.name: Campaign's name
  • campaign.totalClicks: Total clicks for campaign
  • campaign.actualClicks: Actual clicks for campaign
  • campaign.startDate: Campaign's start date
  • campaign.endDate: Campaign's end date
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.totalClicksFrom: Date from which total click budget is counting.
  • campaign.createDate: Campaign's create date
  • campaign.deleteDate: Campaign's Deletion date
  • campaign.deleted: Is campaign deleted?
  • clickMoney: money paid for clicks
  • clicks: Number of clicks
  • conversions: Number of conversions
  • conversionValue: Value of conversions
  • createDate: create date
  • deleted: is product set deleted?
  • deleteDate: ad's delete date
  • 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
  • id: product set id
  • impressionMoney: money paid for impressions
  • impressions: Number of impressions
  • plaType: type name of PLA
  • status: status of the ad(set by user)
  • totalMoney: total money paid(for clicks and impressions)
  • transactions: Number of transactions
)
}

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 (optional) Start date of given period
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 id (optional) product set id
string plaType (optional) Type name of pla
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
int status return code
string statusMessage verbal description of return code
string session Refreshed session
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

            
        

Copyright © 1996-2019

www.seznam.cz   Help   Contact