Sklik API

Intends

intends.negative.readReport

Return 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).

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:
  • categoryId: intend category id
  • createDate: create date
  • deleted: is insterest deleted?
  • deleteDate: ad's delete date
  • id: intend id
  • status: status of the intend(set by user)
  • 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
)
}

Response

struct {
array report (
struct {
int categoryId (optional) intend category id
datetime createDate (optional) create date
datetime deleteDate (optional) delete date
bool deleted (optional) is insterest deleted?
int id (optional) intend id
string status (optional) status of the intend
struct group { (optional)
datetime createDate (optional) create date
bool deleted (optional) is group deleted?
datetime deleteDate (optional) delete date
int id (optional) group id
string name (optional) group name
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 actualClicks (optional) Actual clicks
datetime createDate (optional) create date
datetime deleteDate (optional) Deletion date
datetime endDate (optional) Campaign end date
bool deleted (optional) is campaign deleted ?
int id (optional) campaign id
string name (optional) Campaign name
datetime startDate (optional) Campaign start date
datetime totalClicksFrom (optional) Date from which total click budget is counting.
int totalClicks (optional) Total clicks
datetime totalBudgetFrom (optional) Date from which total money 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-2019

www.seznam.cz   Help   Contact