Sklik API

Campaigns

campaigns.createReport

Create statistic report for campaigns.

Parameters

struct user {
string session

Session (as retrieved from client.login())

int userId

(optional) Managed user ID

}
struct restrictionFilter {
array ids (

(optional) display campaigns by given ids

int

campaign id

)
array names (

(optional) definition of searching in group 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

}
)
bool isDeleted

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

array mixedStatus (

(optional) return only campaigns with following states:

string

allowed states:

  • active: active
  • active-exhausted_day_budget: out of day credit
  • active-expired_budget: out of credit
  • active-expired_clicks: max number of clicks has been reached
  • active-expired_time: off time plan
  • active-low_budget: low budget
  • active-waiting: waiting for confirmation
  • suspended: suspended by user
  • deleted: deleted
)
array adSelections (

(optional) return only campaigns with following choice of ads:

string

type of choice:

  • cos:
  • cpa:
  • random:
  • weighted:
)
array paymentMethods (

(optional) return only campaignes with following way of payment:

string

way of payment

)
array dailyBudget (

(optional) daily budget

struct {
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 value

value

}
)
array totalBudget (

(optional) total budget

struct {
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 value

value

}
)
array networks (

(optional) return only campaigns focused on network:

string

nets:

  • context_only:
  • fulltext_only:
  • context_and_fulltext:
)
array statisticsConditions (

(optional) conditions for statistics

struct {
string columnName

(optional) type of statistic:

  • impressions:
  • clicks:
  • ctr:
  • clickMoney:
  • avgCpc:
  • avgPosition:
  • conversions:
  • conversionRatio:
  • conversionPrice:
  • conversionValue:
  • transactions:
  • pno:
  • quality:
  • ishExhaustedBudget:
  • ishExhaustedBudgetShare:
  • ishUnderForestThreshold:
  • ishUnderForestThresholdShare:
  • ishUnderLowerThreshold:
  • ishUnderLowerThresholdShare:
  • ishStoppedBySchedule:
  • ishStoppedByScheduleShare:
  • ish:
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

double doubleValue

(optional) value

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

(optional) focus on desktop

bool showOnTablet

(optional) focus on tablet

bool showOnMobile

(optional) focus on mobile.

bool showOnOther

(optional) focus on other devices.

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