Domain Summary V4 (SerpstatDomainProcedure.getDomainsInfo)
The SerpstatDomainProcedure.getDomainsInfo method provides with the summary information for an array of domains. The data set is similar to the Batch analysis report excluding the infomation about link profile.
General request parameters and instructions for using Serpstat API
| Request parameters | |||
| Parameter | Description | Optional | 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.getDomainsInfo |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no | |
| domains | Array of domains | no | ["nike.com", "adidas.com" ] |
| se | ID of the search base to be searched | no | g_us, y_213 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| domain | Analyzed domain |
| visible | Site visibility |
| keywords | Number of keywords found in the chosen search engine |
| traff |
Estimated search traffic based on keyword positions and search volume
|
| visible_dynamic | Change in visibility since the last monitoring |
| keywords_dynamic | Change in the number of keywords since the last monitoring |
| traff_dynamic | Traffic change since the last monitoring |
| ads_dynamic | Dynamics of changes in PPC Ads |
| new_keywords | Number of new keywords for the domain since the last monitoring |
| out_keywords | Number of keywords lost by a domain since the last monitoring |
| rised_keywords | Number of domain keywords for which positions have improved since the last monitoring |
| down_keywords | Number of domain keywords for which positions have dropped since the last monitoring |
| ad_keywords | Number of keywords in PPC |
| ads | Number of PPC Ads |
| prev_date | Previous verification date |
| summary_info | Object with data |
| page | Page number |
| left_lines | API credits remaining |
Credits: for each domain for which information is received, 5 credits is charged. Part of the API response, for which 5 credits is charged:
{
"domain": "adidas.com",
"visible": 38.226520000000001,
"keywords": 1360672,
"traff": 54388418,
"visible_dynamic": 0.47296000000000049,
"keywords_dynamic": -5503,
"traff_dynamic": -370839,
"ads_dynamic": 66,
"new_keywords": 21333,
"out_keywords": 26836,
"rised_keywords": 33457,
"down_keywords": 31140,
"ad_keywords": 203,
"ads": 199,
"prev_date": "2021-05-13"
}Request data:
{
"id": "1",
"method": "SerpstatDomainProcedure.getDomainsInfo",
"params": {
"domains": ["nike.com", "adidas.com"],
"se": "g_us"
}
}Response data:
{
"id": "1",
"result": {
"data": [
{
"domain": "nike.com",
"visible": 222.88057000000001,
"keywords": 2613344,
"traff": 255497238,
"visible_dynamic": 10.063649999999996,
"keywords_dynamic": 9610,
"traff_dynamic": 15189516,
"ads_dynamic": -99,
"new_keywords": 40573,
"out_keywords": 30963,
"rised_keywords": 49642,
"down_keywords": 43635,
"ad_keywords": 1098,
"ads": 840,
"prev_date": "2021-04-29"
},
{
"domain": "adidas.com",
"visible": 38.226520000000001,
"keywords": 1360672,
"traff": 54388418,
"visible_dynamic": 0.47296000000000049,
"keywords_dynamic": -5503,
"traff_dynamic": -370839,
"ads_dynamic": 66,
"new_keywords": 21333,
"out_keywords": 26836,
"rised_keywords": 33457,
"down_keywords": 31140,
"ad_keywords": 203,
"ads": 199,
"prev_date": "2021-05-13"
}
],
"summary_info": {
"page": 1,
"left_lines": 997711
}
}
}