Sklik API

Keywords

keywords.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:
  • cpc: cpc
  • createDate: create date
  • deleteDate: delete date
  • deleted: is keyword deleted ?
  • disabled: is keyword disabled ?
  • id: keyword id
  • matchTypeId: keyword's match type
  • matchType: keyword's match type id
  • name: keyword itself
  • status: status
  • statusId: status id
  • url: keyword url
  • 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.maxCpcContext: maximum cpc on Context network for group's targeting
  • group.maxCpt: maximum cpt(Cost per Thousand) for group's targeting
  • campaign.id: Campaign's id
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.exhaustedTotalBudget: Exhausted total budget
  • campaign.totalBudget: Campaign total budget (if set; in halers)
  • campaign.name: Campaign name
  • campaign.totalClicks: Total allowed clicks for campaign
  • campaign.actualClicks: Actual clicks
  • campaign.totalClicksFrom: Date from which the total click budget is counted
  • campaign.context: is it context campaign?
  • campaign.contextNetwork: Name of targeted context networks
  • campaign.fulltext: is it fulltext campaign?
  • campaign.deleted: is campaign deleted ?
  • campaign.deleteDate: Deletion date
  • campaign.adSelection: Ad selection method
  • campaign.adSelectionId: Ad selection method id
  • campaign.paymentMethod: Payment method
  • campaign.paymentMethodId: Payment method id
  • campaign.startDate: Campaign start date
  • campaign.endDate: Campaign end date
  • campaign.createDate: create date
  • campaign.automaticLocation: Is automatic location enabled.
  • campaign.budgetId: Actual budget id
  • campaign.defaultBudgetId: Default budget id.
  • campaign.deviceDesktop: Is targeting on desktop enabled? [deprecated]
  • campaign.deviceTablet: Is targeting on tablet enabled? [deprecated]
  • campaign.deviceMobil: Is targeting on mobile enabled? [deprecated]
  • campaign.deviceOther: Is targeting on other devices enabled? [deprecated]
  • campaign.devicesPriceRatio: Specific ratio of max CPC/CPT for target device
  • campaign.status: campaign status
  • campaign.statusId: campaign status id
  • 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
  • stoppedBySchedule: missed impressions because of campaign 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
  • isRegisteredBrand: keyword is registered brand
  • isUnsuitable: keyword is unsuitable word
  • isTooGeneric: keyword is too generic
  • isGloballyDisabled: keyword is globally disabled word
  • isTrademark: keyword is trademark
  • isSuspicious: keyword is suspicious word
)
}

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 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
}
)
int cpc (optional) cpc
datetime createDate (optional) create date
datetime deleteDate (optional) delete date
bool deleted (optional) is keyword deleted ?
bool disabled (optional) is keyword disabled?
long id (optional) keyword id
string name (optional) keyword itself
int matchTypeId (optional) keyword's match type
string matchType (optional) keyword's match type id
int maxCpc (optional) maximum cpc for keyword
string status (optional) status
int statusId (optional) status id
string url (optional) keyword url
bool isRegisteredBrand (optional) keyword is registered brand
bool isUnsuitable (optional) keyword is unsuitable word
bool isTooGeneric (optional) keyword is too generic
bool isGloballyDisabled (optional) keyword is globally disabled word
bool isTrademark (optional) keyword is trademark
bool isSuspicious (optional) keyword is suspicious word
struct group { (optional)
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 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
}
struct campaign { (optional) keyword's campaign info
int actualClicks (optional) Actual clicks
int adSelectionId (optional) Ad selection method id
string adSelection (optional) Ad selection method
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 defaultBudgetId (optional) Default budget id.
int dayBudget (optional) Day budget
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
string status (optional) Campaign status
int statusId (optional) Campaign status id
int totalBudget (optional) Total allowed budget for campaign
datetime totalBudgetFrom (optional) Date from which the total money budget is counted
int totalClicks (optional) Total allowed clicks for campaign
datetime totalClicksFrom (optional) Date from which the total click budget is counted
}
}
)
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