Sklik API

Ads

ads.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.
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 (

(optional) show following entity attributes

string

column name:

  • adStatus: ad's status(set by system)
  • adType: ad's type
  • clickthruText: Url showed in ad
  • clickthruUrl: Ad's url
  • createDate: create date
  • creative1: creative1
  • creative2: creative2
  • creative3: creative3
  • deleted: is ad deleted?
  • deleteDate: ad's delete date
  • description: Description
  • description2: Description 2
  • finalUrl: Final URL
  • headline1: Headline 1
  • headline2: Headline 2
  • headline3: Headline 3
  • id: ad's id
  • path1: Part path 1
  • path2: Part path 2
  • longLine: Long line
  • shortLine: Short line
  • name: ad name
  • companyName: Company or brand name
  • image.id: Image id
  • image.url: Image URL
  • image.width: Image width
  • image.height: Image height
  • image.size: Image size
  • imageLogo.id: Logo image id
  • imageLogo.url: Logo image URL
  • imageLogo.width: Logo image width
  • imageLogo.height: Logo image height
  • imageLogo.size: Logo image size
  • imageSquare.id: Square image id
  • imageSquare.url: Square image URL
  • imageSquare.width: Square image width
  • imageSquare.height: Square image height
  • imageSquare.size: Square image size
  • imageLandscapeLogo.id: Landscape image id
  • imageLandscapeLogo.url: Landscape image URL
  • imageLandscapeLogo.width: Landscape image width
  • imageLandscapeLogo.height: Landscape image height
  • imageLandscapeLogo.size: Landscape image size
  • skipRate: Skips / impressions
  • views: Number of views (watched 100%)
  • viewRate: Views / impressions
  • avgCostPerView: (Money + impressionMoney) / engagement (watched more then 30s or 100% or clicked)
  • viewershipRate: Quartile reporting of viewership rate. Viewership / impressions [25%, 50%, 75%, 100%]
  • mobileFinalUrl: Mobile Final URL
  • impressionTrackingTemplate: Impression tracking template
  • premiseId: firmy premise ID for ad
  • premiseModeId: mode ID for firmy premise for ad
  • premiseMode: mode for firmy premise for ad
  • sensitivity: ad's sensitivity
  • status: status of the ad (set by user)
  • trackingTemplate: Tracking template
  • 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
  • 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

string devicePhone

(optional) Statistics for phone

string deviceTablet

(optional) Statistics for tablet

string deviceDesktop

(optional) Statistics for desktop

string deviceOther

(optional) Statistics for other devices

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 views

(optional) Number of views (watched 100%)

struct viewershipRate {

(optional) Quartile reporting of viewership rate.

double firstQuartile

Viewership / impressions 25%

double midpoint

Viewership / impressions 50%

double thirdQuartile

Viewership / impressions 75%

double complete

Viewership / impressions 100%

}
double viewRate

(optional) Views / impressions

double skipRate

(optional) Skips / impressions

double avgCostPerView

(optional) (Money + impressionMoney) / engagement (watched more then 30s or 100% or clicked)

}
)
string adStatus

(optional) ad's status(set by system)

string adType

(optional) ad's type

datetime createDate

(optional) create date

datetime deleteDate

(optional) delete date

string creative1

(optional) creative1

string creative2

(optional) creative2

string creative3

(optional) creative3

string clickthruText

(optional) URL that is displayed

string clickthruUrl

(optional) URL to which is the user redirected after clicking on the displayed URL

string finalUrl

(optional) Final URL

string mobileFinalUrl

(optional) Mobile final URL

string headline1

(optional) Headline 1

string headline2

(optional) Headline 2

string headline3

(optional) Headline 3

string name

(optional) ad name

string description

(optional) Description

string description2

(optional) Description 2

bool deleted

(optional) is ad deleted?

int id

(optional) ad's id

string path1

(optional) Path 1

string path2

(optional) Path 2

string longLine

(optional) Longer line of ad

string shortLine

(optional) Shorter line of ad

string companyName

(optional) Company or brand name

struct image {

(optional)

int id

(optional) image id

int width

(optional) image width

int height

(optional) image height

int size

(optional) image size

string url

(optional) image url

}
struct imageLogo {

(optional)

int id

(optional) imageLogo id

int width

(optional) imageLogo width

int height

(optional) imageLogo height

int size

(optional) imageLogo size

string url

(optional) imageLogo url

}
struct imageSquare {

(optional)

int id

(optional) imageSquare id

int width

(optional) imageSquare width

int height

(optional) imageSquare height

int size

(optional) imageSquare size

string url

(optional) imageSquare url

}
struct imageLandscapeLogo {

(optional)

int id

(optional) imageLandscapeLogo id

int width

(optional) imageLandscapeLogo width

int height

(optional) imageLandscapeLogo height

int size

(optional) imageLandscapeLogo size

string url

(optional) imageLandscapeLogo url

}
double skipRate

(optional) Skips / impressions

int views

(optional) Number of views (watched 100%)

double viewRate

(optional) Views / impressions

double avgCostPerView

(optional) (Money + impressionMoney) / engagement (watched more then 30s or 100% or clicked)

struct viewershipRate {

(optional) Quartile reporting of viewership rate. Viewership / impressions [25%, 50%, 75%, 100%]

double firstQuartile

(optional) viewershipRate firstQuartile,

double midpoint

(optional) viewershipRate midpoint,

double thirdQuartile

(optional) viewershipRate thirdQuartile,

double complete

(optional) viewershipRate complete

}
int premiseId

(optional) (can be null) firmy premise ID for ad

int premiseModeId

(optional) (can be null) mode ID for firmy premise for ad

string premiseMode

(optional) (can be null) mode for firmy premise for ad:

  • disabled: Assigned premise is not shown
  • random: Random premise is shown (deprecated)
  • one: Premise specified in premiseId is shown
  • nearest: Client nearest premise is shown
  • inherit: Premise specified in its campaign is shown
string sensitivity

(optional) erotic sensitivity of ad

string status

(optional) status of the ad(set by user)

string trackingTemplate

(optional) Tracking template

string impressionTrackingTemplate

(optional) Template for impressions

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.

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