Sklik API

Retargeting

retargeting.campaign.negative.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
  • createDate: create date
  • retargetingId: retargeting id
  • active: active id
  • isCombination: is combination
  • name: name
  • membership: membership
  • users: users
  • suspendDate: Date of closing retargeting list
  • useHistoricData: use historic data
  • description: description
  • takeAllUsers: take all users
  • indexDate: index date
  • isDynamic: is dynamic
  • deleteDate: delete date
  • deleted: is retargeting deleted ?
  • 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
)
}

Response

struct {
array report (
struct {
int id

(optional) retargeting id

string name

(optional) Name of retargeting list.

bool isCombination

(optional) Bool if retargeting list is combination

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