Sklik API

Groups

groups.stats

DEPRECATED METHOD

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.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:
  • createDate: Group's create date
  • deleted: Is group deleted?
  • deleteDate: Group's delete date
  • id: Group's id
  • maxCpc: maximum cpc for group's targeting
  • maxCpcContext: maximum cpc on Context network for group's targeting
  • maxUserDailyImpressions: max impressions per day for ads within this group
  • maxCpt: maximum cpt(Cost per Thousand) for group's targeting
  • name: Group's name
  • sensitivity: group's erotic sensitivity
  • status: status
  • statusId: status id
  • devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.actualClicks: Actual clicks for campaign
  • campaign.automaticLocation: Is automatic location enabled.
  • campaign.adSelection: Ad selection method
  • campaign.adSelectionId: Ad selection method id
  • campaign.createDate: Campaign's create date
  • campaign.context: is it context campaign?
  • campaign.contextNetwork: Name of targeted context networks
  • campaign.deleteDate: Campaign's Deletion date
  • campaign.deleted: Is campaign deleted?
  • campaign.deviceDesktop: Is targeting on desktop enabled? [deprecated]
  • campaign.deviceTablet: Is targeting on tablet enabled? [deprecated]
  • campaign.deviceMobil: Is targeting on mobil enabled? [deprecated]
  • campaign.deviceOther: Is targeting on other devices enabled? [deprecated]
  • campaign.devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.endDate: Campaign's end date
  • campaign.exhaustedTotalBudget: Exhausted total budget
  • campaign.fulltext: is it fulltext campaign?
  • campaign.id: Campaign's id
  • campaign.name: Campaign's name
  • campaign.paymentMethod: Payment method
  • campaign.paymentMethodId:
  • campaign.startDate: Campaign's start date
  • campaign.status: campaign status
  • campaign.statusId: campaign status id
  • campaign.totalClicks: Total clicks for campaign
  • campaign.totalBudget: Campaign total budget (if set; in halers)
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.totalClicksFrom: Date from which total click budget is counting.
  • 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
)
}

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
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
}
)
datetime createDate (optional) create date
bool deleted (optional) is group deleted?
datetime deleteDate (optional) delete date
int id (optional) group id
string name (optional) group name
int maxUserDailyImpressions (optional) max impressions per day for ads within this group
int maxCpc (optional) maximum cpc for group's targeting
int maxCpcContext (optional) maximum cpc on Context network for group's targeting
int maxCpt (optional) maximum cpt(Cost per Thousand) for group's targeting
string sensitivity (optional) group's erotic sensitivity
string status (optional) group's status
int statusId (optional) status 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
int other Other devices
}
struct campaign { (optional) keyword's campaign info
int actualClicks (optional) Actual clicks
string adSelection (optional) Ad selection method
int adSelectionId (optional) Ad selection method id
bool automaticLocation (optional) Is automatic location enabled.
int budgetId (optional) Actual budget id
bool context (optional) is it context campaign?
string contextNetwork (optional) Name of targeted context networks
datetime createDate (optional) create date
int dayBudget (optional) Day budget
int defaultBudgetId (optional) Default budget id.
bool deleted (optional) is campaign deleted ?
datetime deleteDate (optional) Deletion date
bool deviceDesktop (optional) Is targeting on desktop enabled? [deprecated]
bool deviceTablet (optional) Is targeting on tablet enabled? [deprecated]
bool deviceMobil (optional) Is targeting on mobile enabled? [deprecated]
bool deviceOther (optional) Is targeting on other devices enabled? [deprecated]
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
int other Other devices
}
datetime endDate (optional) Campaign end date
int exhaustedTotalBudget (optional) Exhausted total budget
bool fulltext (optional) is it fulltext campaign?
int id (optional) campaign id
string name (optional) Campaign name
int paymentMethodId (optional) Payment method id
string paymentMethod (optional) Payment method
datetime startDate (optional) Campaign start date
int statusId (optional) campaign status id
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.
}
}
)
int reportId id of report
int status return code
string statusMessage verbal description of return code
string session Refreshed session
array diagnostics ( (optional) Various diagnostics(warnings, errors, other information)
struct {
...
}
)
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

            
        

Copyright © 1996-2019

www.seznam.cz   Help   Contact