Domain history
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
Request parameters | |||||
Parameter | Description | Type | Optional | Default value | Value options |
id | A request id: the response contains the same id. Enter any number (number) or text (string) value | int/string | no | Text or number value. For example: 1, test | |
method | API method name | string | no | SerpstatDomainProcedure.getDomainsHistory | |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |||
domain | Domain name | string | no | Text value of the analyzed domain. for example: nike.com | |
se | ID of the search base to be searched. | string | no | g_us, g_ca databases list | |
sort | Order of sorting the results in the format: {{{field}}: {{order}}} field — field to sort by order — sort direction | object | yes | field: "keywords" | |
page | Page number in response | int | yes | 1 | "page": 1 (any number value) |
size | Number of results per page in response | int | yes | 100 | "size": 10 (any number value) |
filters | Filter conditions | object | yes | "visible": 30 "traff": 1000 | |
during_all_time | History period | boolean | yes | false | true – get information on All time |
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"
},
{
"id": "1",
"method": "SerpstatDomainProcedure.getDomainsHistory",
"params": {
"domain": "nike.com",
"se": "g_us",
"sort": { "date": "desc"},
"size": 20,
"filters": {"visible_from": 315},
"during_all_time": true
}
}
{
"id": "1",
"result": {
"data": [
{
"domain": "nike.com",
"keywords": 3175733,
"traff": 124030271,
"visible": 321.01933000000002,
"visible_static": 321.01933000000002,
"new_keywords": 402174,
"out_keywords": 181443,
"rised_keywords": 201436,
"down_keywords": 175548,
"ad_keywords": 3902,
"ads": 2968,
"date": "2022-07-30"
},
{
"domain": "nike.com",
"keywords": 2864240,
"traff": 120305851,
"visible": 318.67892999999998,
"visible_static": 318.67892999999998,
"new_keywords": 17958,
"out_keywords": 10231,
"rised_keywords": 22929,
"down_keywords": 15477,
"ad_keywords": 1046,
"ads": 934,
"date": "2022-06-03"
},
{
"domain": "nike.com",
"keywords": 2856513,
"traff": 117422687,
"visible": 318.90147999999999,
"visible_static": 318.90147999999999,
"new_keywords": 32115,
"out_keywords": 25209,
"rised_keywords": 36776,
"down_keywords": 39943,
"ad_keywords": 921,
"ads": 823,
"date": "2022-05-20"
},
{
"domain": "nike.com",
"keywords": 3181128,
"traff": 128046844,
"visible": 316.96537999999998,
"visible_static": 316.96537999999998,
"new_keywords": 27433,
"out_keywords": 11143,
"rised_keywords": 24665,
"down_keywords": 23018,
"ad_keywords": 3327,
"ads": 2964,
"date": "2022-01-18"
},
{
"domain": "nike.com",
"keywords": 727939,
"traff": 15070081,
"visible": 422.66820999999999,
"visible_static": 422.66820999999999,
"new_keywords": 1853,
"out_keywords": 1166,
"rised_keywords": 2071,
"down_keywords": 812,
"ad_keywords": 11594,
"ads": 3815,
"date": "2017-03-22"
}
],
"summary_info": {
"page": 1,
"total": 5,
"left_lines": 935732
}
}
}
Serpstat API request drafts: link