Domain History (domain_history)

domain_history

This report provides you with the historical data on a domain’s number of keywords and visibility.

Metrics	Description
result	Encapsulates the answer
visible_static	Visibility
visible	Site visibility
domain	Domain
keywords	The number of keywords found in the chosen search engine
ads	Number of Ads as of ""date""
ad_keywords	Number of keywords in ads
new_keywords	Number of new keywords
out_keywords	Number of keywords which were lost by a domain in the last N-days
rised_keywords	Number of domain's keywords which positions have improved over the last N-days
down_keywords	Number of domain's keywords which positions have dropped over the last N-days
date	Verification date of a particular array element
traff	Approximate organic traffic prognosis
status_msg	Response "Ok" or "Error" report on a successful or unsuccessful request
status_code	Response code "200" — successful request. Errors occur when limits are exceeded (number of simultaneous requests or account limits)
left_lines	API limits remaining

Part of the API response, for which 1 limit is charged:

`{ "visible_static": 0.0087, "domain": "serpstat.com", "ads": 191, "visible": 0.0087, "rised_keywords": 32, "keywords": 430, "down_keywords": 28, "new_keywords": 101, "ad_keywords": 293, "traff": 2575, "out_keywords": 37, "date": "2016-11-13" },`

Example PHP Python

Request data:

api.serpstat.com/v3/domain_history?query=example.com&token=XXX&se=XXX

Response data:

{
  "result": [
    {
      "visible_static": 0.0087,
      "domain": "serpstat.com",
      "ads": 191,
      "visible": 0.0087,
      "rised_keywords": 32,
      "keywords": 430,
      "down_keywords": 28,
      "new_keywords": 101,
      "ad_keywords": 293,
      "traff": 2575,
      "out_keywords": 37,
      "date": "2016-11-13"
    },
    {
      "domain": "serpstat.com",
      "rised_keywords": 126,
      "visible": 0.5986,
      "traff": 21714,
      "keywords": 2131,
      "visible_static": 0.5986,
      "date": "2017-10-23",
      "ads": 108,
      "new_keywords": 90,
      "down_keywords": 100,
      "ad_keywords": 247,
      "out_keywords": 61
    }
  ],
  "status_msg": "OK",
  "status_code": 200,
  "left_lines": 9878
}

<?php
// This example works on serpstat-sdk only
// https://github.com/SerpstatGlobal/serpstat-sdk

require_once __DIR__ . '/../vendor/autoload.php';
// configure your application
$config = [
    'token' => '19666fc1ae1724da1d5ea2f3a99d5f5a',
];
$domain = 'example.com';
// init client with your serpstat api token
$apiClient = new \Serpstat\Sdk\Core\ApiGuzzleHttpClient($config['token']);
// create instance of any api method class
// list of methods classes in folder src\Methods
$apiMethod = new \Serpstat\Sdk\Methods\DomainHistoryMethod(
    $domain,
    \Serpstat\Sdk\Interfaces\IApiClient::SE_GOOGLE_RU
);
try {
    // try call api method
    $response = $apiClient->call($apiMethod);
} catch (\Exception $e) {
    // catch api error
    $response = $e->getMessage();
}

import codecs
import json
import pprint
import urllib.request as urlrequest
from urllib.parse import urlencode

host = 'http://api.serpstat.com/v3'

method = 'domain_history'
params = {
    'query': 'example.com',  # string for get info
    'se': 'g_us',  # string search engine
    'token': 'ijmiom4f5m34905g03um8342dm04923lre3w',  # string personal token
}

api_url = "{host}/{method}?{params}".format(
    host=host,
    method=method,
    params=urlencode(params)
)

try:
    json_data = urlrequest.urlopen(api_url).read()
except Exception as e0:
    print("API request error: {error}".format(error=e0))

data = json.loads(json_data)
pprint.pprint(data)