Sklik API

Retargeting

retargeting.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.
Method can also return other entity attributes(similar to list(...) method),
however this can slow down the report.

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: retargeting list id
  • retargetingId: retargeting id
  • active: active id
  • cpc: cpc
  • cpt: cpt
  • isCombination: is combination
  • name: name
  • membership: membership
  • users: users
  • useHistoricData: use historic data
  • description: description
  • createDate: create date
  • takeAllUsers: take all users
  • indexDate: index date
  • isDynamic: is dynamic
  • deleteDate: delete date
  • listDeleted: is retargeting list deleted ?
  • deleted: is retargeting group deleted ?
  • suspendDate: Date of closing retargeting list
  • status: status retargeting list
  • retargetingConditions.id: retargeting condition id
  • retargetingConditions.groupId: retargeting condition group id
  • retargetingConditions.value: retargeting condition value
  • retargetingConditions.type: retargeting condition type
  • retargetingConditions.key: retargeting condition key
  • 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
  • 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
  • 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
)
}

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 id

(optional) retargeting id

int cpc

(optional) cpc

int cpt

(optional) cpt

datetime createDate

(optional) create date

datetime deleteDate

(optional) delete date

bool deleted

(optional) is retargeting group deleted?

bool listDeleted

(optional) is retargeting list deleted?

string status

(optional) status of the retargeting

string name

(optional) Name of retargeting list.

int retargetingId

(optional) Retargeting code

bool active

(optional) is retargeting list active?

int membership

(optional) Duration in days user will be in this

bool useHistoricData

(optional) Include users by url requests requested

bool takeAllUsers

(optional) Include all url requests to retargeting list.

string description

(optional) Description of Retargeting list

bool isCombination

(optional) Bool if retargeting list is combination

datetime suspendDate

(optional) Date of closing retargeting list

array retargetingConditions (

(optional)

struct {
string value

(optional) condition value

int id

(optional) condition id

int groupId

(optional) condition group id

string type

(optional) condition type

string key

(optional) condition key

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

www.seznam.cz Help Contact