Competitors in organic search results
The SerpstatDomainProcedure.getOrganicCompetitorsPage method brings in the list of domain competitors in top 20 Google search results. The data set is similar to the Competitors report of the domain.
General request parameters and instructions for using Serpstat API
Search databases available
Request parameters | |||||
Parameter | Description | Type | Required | Default value | Value options |
id | A request id: the response contains the same id. Enter any number (number) or text (string) value | int/string | yes | 1, test | |
method | API method name | string | yes | SerpstatDomainProcedure.getOrganicCompetitorsPage | |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | array | yes |
|
|
domain | Domain name | string | yes |
| allo.ua |
se | ID of the search base to be searched. | string | yes |
| g_ua |
sort | Sort by data (ascending and descending) | array | no | {"relevance":"desc"} | "missing": "asc"/"desc" (asc — ascending sort direction, desc — descending) - Missing keywords |
page | Page number in response | int | no | 1 | "page": "5" |
size | Number of results per page in response | int | no | 100 | "size": "50" |
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
data | Array with data |
domain | Analyzed domain/Competitor domain |
favicon | Direct link to the site's favicon |
all | The total number of keywords of the site. |
currentValue | Current value of the keywords number. |
dynamicValue | Dynamics of the keywords number in comparison with the previous data update. |
common | The number of common keywords in competing domains containing the analyzed |
visibility | Visibility of a domain in top-20 search results. It's a relative indicator, which is calculated as a ratio of the amount and popularity of keywords a domain is shown for. About visibility |
missing | Number of keywords for which the competing domain is ranked and which are missing from the searched domain |
relevance | Relevance - calculates the percentage of similar keywords domains share (0-100%) |
summary_info | Object with data |
page | Number of a current page |
left_lines | API credits remaining |
Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:
{
"domain": "allo.ua",
"favicon": "https://www.google.com/s2/favicons?domain=allo.ua",
"all": {
"currentValue": 27422390,
"dynamicValue": -5793
},
"common": {
"currentValue": 27400104,
"dynamicValue": 100
},
"visibility": {
"currentValue": 1177.45001,
"dynamicValue": -19.070609999999988
},
"missing": 0,
"relevance": 100
},
{
"id": 1,
"method": "SerpstatDomainProcedure.getOrganicCompetitorsPage",
"params": {
"domain": "allo.ua",
"se": "g_ua",
"sort": {"common":"asc"},
"page": "1",
"size": "10"
}
}
{
"id": "1",
"result": {
"data": [
{
"domain": "allo.ua",
"favicon": "https://www.google.com/s2/favicons?domain=allo.ua",
"all": {
"currentValue": 27417221,
"dynamicValue": -5169
},
"common": {
"currentValue": 27400661,
"dynamicValue": 100
},
"visibility": {
"currentValue": 1207.9735900000001,
"dynamicValue": 30.523580000000038
},
"missing": 0,
"relevance": 100
},
{
"domain": "rozetka.com.ua",
"favicon": "https://www.google.com/s2/favicons?domain=rozetka.com.ua",
"all": {
"currentValue": 75107440,
"dynamicValue": 9053
},
"common": {
"currentValue": 23615758,
"dynamicValue": 86.189999999999998
},
"visibility": {
"currentValue": 10243.596100000001,
"dynamicValue": 64.100089999999909
},
"missing": 51491682,
"relevance": 31.440000000000001
},
{
"domain": "prom.ua",
"favicon": "https://www.google.com/s2/favicons?domain=prom.ua",
"all": {
"currentValue": 92710354,
"dynamicValue": 3123
},
"common": {
"currentValue": 22507257,
"dynamicValue": 82.140000000000001
},
"visibility": {
"currentValue": 4565.8292499999998,
"dynamicValue": -68.190230000000156
},
"missing": 70203097,
"relevance": 24.280000000000001
}
],
"summary_info": {
"page": 1,
"left_lines": 9999791
}
}
}