Sklik API

Sitelinks

sitelinks.readReport

Get statistics for sitelinks by provided sitelink IDs.

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

filter 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: sitelink id
  • createDate: create date
  • deleted: is sitelink deleted ?
  • deletedSitelinkInGroup: is sitelink in group deleted ?
  • status: status
  • statusId: status id
  • name: sitelink itself
  • urlId: sitelink url id
  • url: sitelink url
  • indexDate: index 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
  • campaign.actualClicks: Actual clicks for campaign
  • campaign.createDate: Campaign's create date
  • campaign.deleteDate: Campaign's Deletion date
  • campaign.deleted: Is campaign deleted?
  • campaign.endDate: Campaign's end date
  • campaign.id: Campaign's id
  • campaign.name: Campaign's name
  • campaign.startDate: Campaign's start date
  • campaign.totalBudgetFrom: Date from which total money budget is counting.
  • campaign.totalClicksFrom: Date from which total click budget is counting.
  • campaign.totalClicks: Total clicks for campaign
  • user.id: Owner's user's id.
  • clicks: clicks
  • impressions: impressions
  • clickMoney: money paid for clicks
  • impressionMoney: money paid for impressions
  • totalMoney: total money paid
  • avgPos: average position (float)
  • conversions: conversions count
  • transactions: transactions count
  • 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
)
}

Response

struct {
array report (
struct {
int id

sitelink id

datetime createDate

create date

bool deleted

is sitelink deleted ?

bool deletedSitelinkInGroup

is sitelink in group deleted ?

string status

status

int statusId

status id

string name

sitelink itself

int urlId

sitelink url id

string url

sitelink url

datetime indexDate

index date

string adminNote

admin note

struct group {

(optional)

datetime createDate

(optional) create date

bool deleted

(optional) is group deleted?

datetime deleteDate

(optional) delete date

int id

(optional) group id

int maxCpc

(optional) maximum cpc for group's targeting

int maxCpt

(optional) maximum cpt(Cost per Thousand) for group's targeting

string name

(optional) group name

}
struct campaign {

(optional)

int actualClicks

(optional) Actual clicks

datetime createDate

(optional) create date

datetime deleteDate

(optional) Deletion date

bool deleted

(optional) is campaign deleted ?

datetime endDate

(optional) Campaign end date

int id

(optional) campaign id

string name

(optional) Campaign name

datetime startDate

(optional) Campaign start date

datetime totalBudgetFrom

(optional) Date from which total money budget is counting.

int totalClicks

(optional) Total clicks

datetime totalClicksFrom

(optional) Date from which total click budget is counting.

bool sharedBudget

(optional) Is budget shared?

}
int clicks

(optional)

int impressions

(optional)

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 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-2020

www.seznam.cz Help Contact