Sklik API

Patterns

patterns.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.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 ( show following entity attributes
string column name:
  • id: Pattern id
  • pattern: Pattern name
  • categoryId: category id
  • indexDate: Pattern index date
  • createDate: Pattern create date
  • deleteDate: delete date
  • deleted: is pattern deleted ?
  • status: status
  • cpc: Cost per click
  • cpt: cpm et for pattern
  • 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
  • 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?
  • avgCpc: average cost per click
  • avgPos: average position (float)
  • avgPosition: average position (int number * 100)
  • clickMoney: money paid for clicks
  • clicks: clicks
  • convCost: cost of conversions
  • conversionPrice: cost of conversions
  • conversionRatio: conversions rate
  • conversions: conversions count
  • conversionValue: conversions value
  • convRate: conversions rate
  • ctr: Click Through Rate
  • exhaustedBudget: missed impressions because of exhausted budget
  • exhaustedBudgetShare: missed impressions because of exhausted shared budget
  • impressionMoney: money paid for impressions
  • impressions: impressions
  • impressionsFtx: impressions in fulltext network
  • ish: not missed impressions percentage
  • lowQuality: entity has low quality(lot missed impressions because of low cpc or relevancy
  • missedPrice: not paid money because of lost impressions due to exhausted budget or stopped schedule
  • missImpressions: missed impressions
  • pno: Cost Of Sale(COS)
  • quality: quality
  • qualityHistogram: quality histogram
  • stoppedBySchedule: missed impressions because of campaign schedule
  • totalMoney: total money paid
  • transactions: transactions count
  • underForestThreshold: missed impressions because of low relevancy
  • underLowerThreshold: missed impressions because of low cpc
  • value: conversions value
)
}

Response

struct {
array report (
struct {
array stats ( statistics
struct {
datetime date Start date of given period
int avgCpc (optional) average cost per click
double avgPos (optional) average position (float)
int avgPosition (optional) average position (int number * 100)
int clickMoney (optional) money paid for clicks
int clicks (optional) clicks
int convCost (optional) cost of conversions
int conversionPrice (optional) cost of conversions
int conversionRatio (optional) conversions rate
int conversions (optional) conversions count
int conversionValue (optional) conversions value
int convRate (optional) conversions rate
int ctr (optional) Click Through Rate
int exhaustedBudget (optional) missed impressions because of exhausted budget
int exhaustedBudgetShare (optional) missed impressions because of exhausted shared budget
int impressionMoney (optional) money paid for impressions
int impressions (optional) impressions
int impressionsFtx (optional) impressions in fulltext network
int ish (optional) not missed impressions percentage
int lowQuality (optional) entity has low quality(lot missed impressions because of low cpc or relevancy
int missedPrice (optional) not paid money because of lost impressions due to exhausted budget or stopped schedule
int missImpressions (optional) missed impressions
int pno (optional) Cost Of Sale(COS)
int quality (optional) quality
int qualityHistogram (optional) quality histogram
int stoppedBySchedule (optional) missed impressions because of campaign schedule
int totalMoney (optional) total money paid
int transactions (optional) transactions count
int underForestThreshold (optional) missed impressions because of low relevancy
int underLowerThreshold (optional) missed impressions because of low cpc
int value (optional) conversions value
}
)
int id (optional) pattern id
string pattern (optional) pattern itself
int categoryId (optional) pattern category id
datetime createDate (optional) create date
datetime indexDate (optional) index date
datetime deleteDate (optional) delete date
bool deleted (optional) is keyword deleted ?
int status (optional) status
int cpc (optional) maximum cpc for pattern
int cpt (optional) maximum cpm for pattern
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
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