Sklik API

Banners

banners.createReport

Create statistic report for ads.

Parameters

struct user {
string session

Session (as retrieved from client.login())

int userId

(optional) Managed user ID

}
struct restrictionFilter {
array ids (

(optional) display ads by given ids

int

ad id

)
array creatives (

(optional) definition of searching in creative(excludes: mixedText)

struct {
string operator

comparison for following operators:

  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value

value

}
)
array mixedText (

(optional) search in ads creative + banner names (excludes: creatives)

struct {
string operator

comparison for following operators:

  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value

value

}
)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.

array status (

(optional) return only ads with following states:

string

states:

  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
array adStatus (

(optional) return only ads with following substates

string

ads states:

  • new: new
  • waiting: waiting for confirmation
  • allow: confirmed
  • deny: denied
  • noactive: inactive - suspended by system
  • deny_excess_punctuation: excess of punctuation
  • deny_bad_uppercase_usage: bad uppercase usage
  • deny_exclamation_mark_in_title: exclamation mark in title
  • deny_excess_words_duplication: excess of word repetition
  • deny_disallowed_language: disallowed language
  • deny_nonsensical_text: nonsensical text
  • deny_superlative_in_text: superlative in text
  • deny_general_phrase: general phrase
  • deny_unmatched_domain: unmatched domain
  • deny_nonexistent_domain: domain does not exist
  • deny_invalid_url: invalid URL
  • deny_url_under_construction: url under construction
  • deny_unsuitable_url: unsuitable url
  • deny_false_advertising: false advertising
  • deny_mention_of_competition: mention of competition
  • deny_not_conjoint_with_target_page: not conjoint with target page
  • deny_not_conjoint_with_keywords: not conjoint with keywords
  • deny_unverifiable_prices: unverifiable prices
  • deny_erotic_content: erotic content
  • deny_disallowed_content: disallowed content
  • deny_trademark: trademark
  • deny_not_diacritical_text: text without diacritical
  • deny_missing_space: missing space
  • deny_averment_of_uniqueness: claim of uniqueness
  • deny_discount_with_reffered_value: discount with listed value
  • deny_untypical_abbreviation: untypical abbreviation
  • deny_typing_or_grammatical_error: typing or grammatical error
  • deny_impenetrable_words_dividing: impenetrable words dividing
  • deny_problem_with_punctuation: problem with punctuation
  • noactive_unsupported_size: inactive - unsupported dimension
)
array mixedStatus (

(optional) return only ads with following substates:

string

ads states:

  • active: active(no restriction)
  • waiting: waiting for confirmation
  • active-erotic: inappropriate for kids
  • active-porn: adult only
  • deny: denied
  • suspended: suspended by user
  • deleted: deleted
)
array eroticSensitivity (

(optional) return only ads with detection of erotic content:

string

states:

  • harmless: harmless
  • erotic: inappropriate for kids
  • porn: adult only
)
array urls (

(optional) definition of searching in url

struct {
string operator

comparison for following operators:

  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase (does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value

value

}
)
struct banner {

(optional) filters for banners

array names (

(optional) definition of searching in banner names

struct {
string operator

comparison for following operators:

string value

value

}
)
array dimensions (

(optional) banner dimension (banner must have one of following dimension):

struct {
int width

(optional) width of banner

int height

(optional) height of banner

}
)
}
array statisticsConditions (

(optional) conditions for statistics

struct {
string columnName

(optional) type of statistic:

  • impressions: type int
  • clicks: type int
  • ctr: type double
  • avgCpc: type double
  • avgPosition: type double (1.0 and greater)
  • conversions: type int
  • conversionRatio: type double (range 0.0 – 1.0)
  • conversionPrice: type double
  • conversionValue: type int
  • transactions: type int
  • pno: type double (range 0.0 – 1.0)
  • quality: type int
  • ishExhaustedBudget: type int
  • ishExhaustedBudgetShare: type double (range 0.0 – 1.0)
  • ishStoppedBySchedule: type int
  • ishStoppedByScheduleShare: type double (range 0.0 – 1.0)
  • ishUnderForestThreshold: type int
  • ishUnderForestThresholdShare: type double (range 0.0 – 1.0)
  • ish: type double
string operator

comparison for following operators:

  • EQ: equal
  • NEQ: not equal
  • GT: greater than
  • GTE: greater than or equal
  • LT: less than
  • LTE: less than or equal
int intValue

(optional) value (excludes: doubleValue)

double doubleValue

(optional) value

}
)
struct group {

(optional) filters for superior group

array ids (

(optional) display ads from next groups (excludes: names)

int

group id

)
array names (

(optional) definition of searching in groups names

struct {
string operator

comparison for following operators:

  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value

value

}
)
array mixedStatus (

(optional) return only ads with following states of their groups:

string

states:

  • active: active
  • noactive: suspended by system
  • suspended: suspended by user
  • deleted: deleted
)
array status (

(optional) return only ads with following states of their groups:

string

states:

  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.

}
struct campaign {

(optional) filters for superior campaign

array ids (

(optional) display ads from next campaigns (excludes: names)

int

campaign id

)
array names (

(optional) definition of searching in campaign names

struct {
string operator

comparison for following operators:

  • CONTAINS: contains
  • NOT_CONTAINS: does not contain
  • PHRASE: phrase (contains phrase)
  • NEGATIVE_PHRASE: negative phrase(does not contain phrase)
  • STARTS_WITH: starts with
  • NOT_STARTS_WITH: does not start with
  • ENDS_WITH: ends with
  • NOT_ENDS_WITH: does not end with
string value

value

}
)
array mixedStatus (

(optional) return only ads with following states of their campaigns

string

allowed states:

  • active: active
  • active-exhausted_day_budget: exhausted day budget
  • active-expired_budget: expired budget
  • active-expired_clicks: max number of clicks has been reached
  • active-expired_time: outside time plan
  • active-low_budget: low budget
  • active-waiting: waiting for confirmation
  • suspended: suspended by user
  • deleted: deleted
)
array status (

(optional) return only ads with following states of their campaigns:

string

states:

  • active: active
  • noactive: suspended by system
  • suspend: suspended by user
)
bool isDeleted

(optional) return deleted/undeleted. If unassigned returns both.

}
array deviceType (

(optional) Type of device for stats:

string

(optional) type of the device: [default: deviceAll]

  • devicePhone: stats for phone
  • deviceTablet: stats for tablet
  • deviceOther: stats for other device
  • deviceDesktop: stats for desktop
  • deviceAll: stats summary (total)
)
datetime dateFrom

date from

datetime dateTo

date to

}
struct displayOptions {

(optional) Determines which information are returned. [default: see below]

bool includeCurrentDayStats

(optional) Return inaccurate current day statistics. Date range has to contain actual date! [default: False] (only for statGranularity in ["daily", "total"])

string statGranularity

(optional) Granularity of statistics: [default: total]

  • total: do not split
  • daily: split by days
  • weekly: split by weeks
  • monthly: split by months
  • quarterly: split by quarters
  • yearly: split by year
}

Response

struct {
int reportId

id of report

int status

return code

long totalCount

number of entities

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