Domain history V4 (SerpstatDomainProcedure.getDomainsHistory)

SerpstatDomainProcedure.getDomainsHistory — this report provides you with the historical data on a domain’s number of keywords and visibility.

Request parameters:

Metrics	Description	Optional	Default value	Value options
domain	Domain name	no	-	allo.ua
se	ID of the search base to be searched	no	-	g_ua
sort	Order of sorting the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	yes	-	{"ads":"desc"}
page	Page number in response	yes	1	5
size	Number of results per page in response	yes	100	100-1000

Sorting results is possible by the following fields:

Parameter

date

down_keywords

visible

rised_keywords

keywords

traff

visible_static

new_keywords

out_keywords

down_keywords

ad_keywords

Response metrics:

Metrics:	Description
result	Contains the answer
visible	Site visibility
domain	Domain
keywords	Number of keywords found in the chosen search engine
traff	Estimated organic traffic to a site (number of visitors)
date	Date of current visibility, key phrase, and traffic check
new_keywords	Number of new keywords, for which the domain ranked in the last 2 weeks
out_keywords	Number of keywords for which rankings were lost by a domain over the last 2 weeks
rised_keywords	Number of domain's keywords for which positions have improved over the last 2 weeks
down_keywords	Number of domain's keywords for which positions have dropped over the last 2 weeks
ad_keywords	Number of keywords in PPC
ads	Number of ads in PPC
left_lines	API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained.

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

{
"domain": "google.com",
"rised_keywords": 176915,
"visible": 5995.61211,
"traff": 120802965,
"keywords": 3964146,
"visible_static": 5995.61211,
"date": "2018-07-05",
"ads": 1662,
"new_keywords": 184914,
"down_keywords": 232468,
"ad_keywords": 7638,
"out_keywords": 146804
}

Example PHP Python

Request data:

{
 "id": {{any_num_or_string}},
 "method": "SerpstatDomainProcedure.getDomainsHistory",
 "params": {
   "domain": {{domain}},
   "se": {{search_engine}},
   (optional) "sort": { {{field}}: {{"asc"|"desc"}}},
   (optional) "page": {{page}},
   (optional) "size": {{page_size}}
 }
}

Response data:

{
    "id": {{your_num_or_string}},
    "result": {
        "data": [
            {
                "domain": "google.com",
                "rised_keywords": 176915,
                "visible": 5995.61211,
                "traff": 120802965,
                "keywords": 3964146,
                "visible_static": 5995.61211,
                "date": "2018-07-05",
                "ads": 1662,
                "new_keywords": 184914,
                "down_keywords": 232468,
                "ad_keywords": 7638,
                "out_keywords": 146804
            },
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 99268,
            "total": 3809
        }
    }
}