PPC Keyword Competitors List V4 (SerpstatKeywordProcedure.getAdsCompetitors)
SerpstatKeywordProcedure.getAdsCompetitors — this method performs competitors' search for the given keyword.
Request parameters | |||||
Parameter | Description | Type | Optional | Default value | Value Options |
query | Keyword by which competitors will be searched | string | no | iphone xs | |
se | Search engine ID | string | no | g_us | |
page | Page number in response | int | yes | 1 | 5 |
pageSize | Number of results per page in response | int | yes | 100 | 50-1000 |
sort |
Sort direction: desc — descending; asc — ascending
|
json object | yes | {"common": "desc"} |
Response parameters | |
Parameter | Description |
domain | Competitor's domain |
ads | Number of ads for a domain |
all | Number of keywords for a domain in PPC |
common | Common keywords in PPC |
summary_info | Summary data block |
page | Current page |
left_lines | Number of remaining API lines |
The number of credits spent corresponds to the number of results obtained. This is part of the API response for which 1 credit is charged:
{
"domain": "verizon.com",
"ads": 3785,
"all": 9272,
"common": 231
}
{
"id": 1,
"method": "SerpstatKeywordProcedure.getAdsCompetitors",
"params": {
"query": "iphone xs",
"se": "g_us",
"page": 1,
"pageSize": 100,
"sort": {
"common": "desc"
}
}
}
{
"id": "1",
"result": {
"data": [
{
"domain": "verizon.com",
"ads": 3785,
"all": 9272,
"common": 231
},
],
"summary_info": {
"page": 1,
"left_lines": 999529
}
}
}