Queries are made in JSON format by sending POST request to http://a.scroogefrog.com/api/
JSON contains of 3 mandatory parameters: id, md5, task and optional additional parameters, specific for evert method.
First two parameters contains authentification data. Parameter task - contains API method.
Answer consists of JSON object.
In case of successful query, response object contains property 'ok', that contains answer in its value.
In case of error during query, response object contains property 'error', that contains error description in its value.
The only exeption is add_sites method, which returns array of objects descripted above.
To activate API please contact support.
Authorization is made thought sending user id(given to user during API activation) and md5 from password in json parameter id and md5.
It's prohibited to make more than 60 queries per minute.
In case of breaking this limit user will be blocked for one minute.
In case of breaking limits more that 60 times a day - API will be disabled and could be enabled back only after contacting support.
Using get_stat method with parameter stype=1 or stype=2 counts as 10 queries.
get_stat method with parameter stype=3 can't be used more than one time a day for one site.
get_audit_balance
Returns Traffic Audit balance.
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"get_audit_balance"}'Answer example:
{ "ok": "8000.00" }
get_sites_audit_status
Returns Traffic Audit status for sites.
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"get_sites_audit_status"}'Answer example:
{ "ok": { "1": { "id": "1", "domain": "example.com", "state": "OFF" }, "2": { "id": "2", "domain": "example.org", "state": "ON" } } }Answer description:
get_site_audit_status
Returns Traffic Audit status for site
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"get_site_audit_status", "site_id":1}'Answer example:
{ "ok": "NO CODE", "info": [{ "url": "http:\/\/example.com\/page1", "js_code": 1, "php_code": 0 }, { "url": "http:\/\/example.org\/page2", "js_code": -1, "php_code": 1 }] }Answer description:
get_ban_limits
Return ban limits
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"get_ban_limits"}'Answer example:
{ "ok": { "uid_ban_limit": "-8", "pads_visits_limit": "10", "pad_ban_limit": "-3.30" } }Answer description:
set_ban_limits
Sets ban limits
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"set_ban_limits", "uid_ban_limit": "-8","pads_visits_limit": "10","pad_ban_limit": "-3.30"}'Answer example:
Same as method get_ban_limits
start_stop_audit
Stop or Start Traffic Audit
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"start_stop_audit", "site_id": "2","state": "ON"}'Answer example:
{ "ok": "ON" }
add_sites
Add site to Traffic Audit
Additional parameters:
curl -d '{"id":1,"md5":"e10adc3949ba44ff883e","task":"add_sites", "urls":["example.org","exaple.com"]}'Answer example:
{ [{ "ok": 100 }, { "error": "WRONG URL" }] }Answer description:
check_code
Check if there is code on page
Additional parameters:
curl -d '{"id":1,"md5":"2e676f870f840d33448fa6718cc89db2","task":"check_code", "url":"example.org/12?d=e"}Answer example:
{ "ok": { "php": 1, "js": 0 } }Answer description:
get_stat
Get site stat
Additional parameters:
curl -d '{"id":1,"md5":"e10adc3949ba44ff883e","task":"get_stat","site_id":1,"stype":1, "from":1385501505,"to":1385541505}'Answer example (stype=1):
{ "ok": [ ["1385537718", "93.127.125.94", "example.org\/?_openstat=YmVndW47MzAyMDAwNDUyOzMwMjAwMDQ1ODs", "begun machinelife.ru", "4"], ["1385530612", "209.85.238.9", "example.org\/?utm_source=trafmag&utm_medium=click&tracking=1043", "trafmag (\u043f\u0443\u0441\u0442 \u0440\u0435\u0444\u0435\u0440) 1043", "1"], ["1385505224", "66.249.93.44", "example.org\/?utmka=lalala&keyword&site=example.org", "batterfliay.ru", "16"], ["1385504840", "192.168.1.153", "example.org\/?utm_source=trafmag&utm_campaign=trafmag&tracking=944", "trafmag (\u043f\u0443\u0441\u0442 \u0440\u0435\u0444\u0435\u0440) 944", "4"], ["1385503928", "46.30.167.204", "example.org\/?utm_source=trafmag&utm_medium=click&utm_campaign=trafmag", "trafmag (\u043f\u0443\u0441\u0442 \u0440\u0435\u0444\u0435\u0440) 185", "3"], ["1385503418", "66.249.81.44", "example.org\/?utmka=lalala&keyword&site=5864f0a8cffd909f.anonymous.google", "5864f0a8cffd909f.anonymous.google", "1"] ] }Answer description (stype=1):
{ "ok": [ ["2013-11-27", "adwords mail.google.com", "example.com\/?utmka=lalala&keyword=&site=mail.google.com", "1"], ["2013-11-27", "begun rating.openstat.ru", "example.com\/?_openstat=YmVndW47MzAyMDAwNDUyOzMwMjAwMTE2MD", "1"], ["2013-11-27", "google.com example.org", "example.com\/?utmka=lalala&keyword=&site=example.org", "25"], ["2013-11-26", "google.com example.org", "example.com\/?utmka=lalala&keyword=&site=example.org", "25"] ] }Answer description (stype=2):
{ "ok": [ ["1369297040", "armyansk.info", "0", "77.52.191.86", "B5368", "example.org\/?_openstat=YmVndW47MzE0NTQ4NTQ4OzMxNDU0ODU3MDs", "0,03", "armyansk.info\/transport\/train-schedule"], ["1369297510", "ru.podii.com.ua", "0", "195.24.157.158", "B5372", "example.org\/?_openstat=YmVndW47MzE0NTQ4NTQ4OzMxNDU0ODU3MDs", "0,03", "ru.podii.com.ua\/business\/2013\/05\/23\/103707.html"], ["1369299042", "smotri.com", "-2.69444", "193.108.171.116", "A2008879", "example.org\/?_openstat=YmVndW47MzE0NTQ4NTQ4OzMxNDU0ODU3MDs", "0,03", "smotri.com\/live\/00kleopatra00"], ] }Answer description (stype=3):