Domain history V4 (SerpstatDomainProcedure.getDomainsHistory)
The SerpstatDomainProcedure.getDomainsHistory method provides you with the historical data on a domain’s number of keywords and visibility.
General request parameters and instructions for using Serpstat API
Search databases available
| Request parameters | ||||
| Parameter | Description | Optional | Default value | Value options |
| id | A request id: the response contains the same id. Enter any number (number) or text (string) value | no | 1, test | |
| method | API method name | no | SerpstatDomainProcedure.getDomainsHistory | |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | ||
| domain | Domain name | no | nike.com | |
| se | ID of the search base to be searched (there are both Google and Yandex databases available, for example: g_us or y_157). | no | g_us | |
| sort | Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by: * keywords * traff * visible * visible_static * new_keywords * out_keywords * rised_keywords * down_keywords * ad_keywords * ads * date 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 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Analyzed domain |
| keywords | Number of keywords found in the chosen search engine |
| traff | Estimated search traffic based on keyword positions and search volume |
| visible | Site visibility |
| visible_static | Change in visibility since the last monitoring |
| new_keywords | Number of new keywords since the last N-days monitoring |
| out_keywords | Number of lost keywords since the last N-days monitoring |
| rised_keywords | Number of keywords which positions of the domain have improved over the last N-days |
| down_keywords | Number of keywords which positions of the domain have dropped over the last N-days |
| ad_keywords | Number of keywords in PPC |
| ads | Number of ads in PPC |
| date | Verification date of a particular array element |
| summary_info | Object with data |
| page | Page number |
| total | Number of results for request |
| 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": "nike.com",
"keywords": 2603734,
"traff": 240307722,
"visible": 212.81692,
"visible_static": 212.81692,
"new_keywords": 32499,
"out_keywords": 37326,
"rised_keywords": 40518,
"down_keywords": 43717,
"ad_keywords": 1197,
"ads": 929,
"date": "2021-04-29"
},Request data:
{
"id": "1",
"method": "SerpstatDomainProcedure.getDomainsHistory",
"params": {
"domain": "nike.com",
"se": "g_us",
"sort": { "date": "desc"},
"page": 1,
"size": 100
}
}Response data:
{
"id": "1",
"result": {
"data": [
{
"domain": "nike.com",
"keywords": 2582452,
"traff": 252739307,
"visible": 222.57514,
"visible_static": 222.57514,
"new_keywords": 31381,
"out_keywords": 62273,
"rised_keywords": 48816,
"down_keywords": 42013,
"ad_keywords": 1724,
"ads": 1250,
"date": "2021-05-27"
},
{
"domain": "nike.com",
"keywords": 2613344,
"traff": 255497238,
"visible": 222.88057,
"visible_static": 222.88057,
"new_keywords": 40573,
"out_keywords": 30963,
"rised_keywords": 49642,
"down_keywords": 43635,
"ad_keywords": 1098,
"ads": 840,
"date": "2021-05-13"
}
],
"summary_info": {
"page": 1,
"total": 27,
"left_lines": 997684
}
}
}