Server Requirements
Builder installation / update
On-Premises
Plugin installation
API documentation
Add-ons documentation
For developers
Change Log
API documentation → Licenses

Get statistics of publications/openings Cloud

Notes:
Statistics of on-premises builders are updated only several times a day. Please refrain from calling this method more than once per 3 hours.
Important:
When neither offset nor limit parameters are specified request must still contain an empty JSON object in the body. Otherwise you will receive a response with "Bad input data" error.

HTTP Basic
[API Username will appear after you or sign up]
[API Password will appear after you or sign up]
POST
application/json
application/json

JSON request Object Properties:

  • Number - (optional) if is set then will search statistics of specified brand;
  • String - (optional) can be either "published" or "opened";
  • String - (optional) if is set then will search statistics of specified domain;
  • String - (optional) if is set then will search statistics from specified date (must have format of "YYYY-MM-DD HH:MM:SS");
  • String - (optional) if is set then will search statistics till specified date (must have format of "YYYY-MM-DD HH:MM:SS");

JSON response Object Properties:

  • Boolean - (optional) returned on success, contains value true, indicates successfully executed action;
  • Array of Object - (optional) returned on success, contains a list of statistics. Each object has the following structure:
    • String - domain name;
    • String - either "published" or "opened"
    • String - action date of format "YYYY-MM-DD HH:MM:SS";
    • String - set if action is "published" and ended with error, otherwise is null;
    • Number - brand ID the domain is using;
    • Boolean - indicates whether domain is free (published with "Free" plan) or not;
  • String - (optional) returned on error, contains error message, indicates failure to execute action;