Keyword Ads V4 (SerpstatKeywordProcedure.getAdKeywords)
SerpstatKeywordProcedure.getAdKeywords — this method performs ads search for the given keyword.
Request parameters:
|
Parameter |
Description |
Type |
Optional |
Default value |
Value Options |
|
keyword |
Keyword to search for |
string |
no |
to buy iphone |
|
|
se |
ID of the search base to be searched |
string |
no |
g_ua |
|
|
domains |
Domains list, array |
array |
yes |
[ ] |
["allo.ua", "citrus.ua"] |
|
minusKeywords |
Negative keywords, array |
array |
yes |
[] |
["allo", "alo"] |
|
filters |
Filter conditions |
json object |
yes |
|
{"queries_from": 10} {"queries_to": 10} |
|
sort |
Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending) |
json object |
yes |
{"position": "asc", "region_queries_count":"desc"} |
{"cost": "asc"} |
|
page |
Page number in response |
int |
yes |
1 |
5 |
| size | Number of results per page in response | int | yes | 100 | 50-1000 |
Sorting results is possible by the following fields:
| Parameter |
| keyword_length |
| position |
| type |
| cost |
| concurrency |
| found_results |
| region_queries_count |
| region_queries_count_wide |
| region_queries_count_last |
To filter the results, use the following parameters:
|
Parameter |
Description |
Possible values |
|
queries_from |
Min volume of monthly searches |
0-100000000 |
|
queries_to |
Max volume of monthly searches |
0-100000000 |
|
position_from |
Min position |
1-100 |
|
position_to |
Max position |
1-100 |
|
cost_from |
Min CPC |
0-200 |
|
cost_to |
Max CPC |
0-200 |
|
concurrency_from |
Min value of competitor’s keyword in the PPC | 0-100 |
|
concurrency_to |
Max value of competitor’s keyword in the PPC | 0-100 |
|
results_from |
Min result value | 0-100000000 |
|
results_to |
Max result value | 0-100000000 |
|
length_from |
Min value of a keyword’s length | 0-100000000 |
|
length_to |
Max value of a keyword’s length | 0-100000000 |
Response metrics:
|
Metrics |
Description |
|
result |
Contains the answer |
|
total |
Number of ads found that appear for queries containing the search word |
|
region_queries_count |
Search volume in selected region |
|
region_queries_count_wide |
Search volume (broad match) |
|
domain |
Domain |
|
keyword_length |
Number of words divided by space in a keyword |
|
keyword |
Keyword for which an ad is displayed |
|
title |
Ad title |
|
url |
Ad URL |
|
text |
Ad text |
|
found_results |
Number of results found for “keyword" |
|
cost |
Cost per click, $ |
|
concurrency |
Keyword competition in the PPC (0-100) |
|
position |
Ad position in the PPC |
|
date |
Date of ad update |
|
subdomain |
Subdomain |
|
type |
Ad placement type in relation to SERP (1. Above; 2. Under; 3. Side) |
|
types |
List of special elements shown in SERP (for example, video, carousel or map) |
|
geo_names |
List of toponyms in the array (if toponyms are present in the keywords) |
|
date |
Position check date |
|
left_lines |
Number of remaining API lines |
Limits: the number of charged limits corresponds to the number of results obtained upon request.
Part of the API response, for which 1 credit is charged:
{
"keyword": "купить ноутбуки",
"keyword_length": 2,
"domain": "foxtrot.com.ua",
"subdomain": "www.foxtrot.com.ua",
"url": "https://www.foxtrot.com.ua/ru/shop/noutbuki.html",
"title": "Купить Ноутбуки в Фокстроте | В наличии. Выгодные цены",
"text": "Заказывайте в интернете - забирайте в удобное время в магазине Фокстрот! Кредит до 24 месяцев. Цена проверена. Официальная гарантия. Акции каждый день. Места: Киев, Харьков.",
"position": 1,
"type": 1,
"cost": 0.120833,
"concurrency": 100,
"found_results": 52700000,
"region_queries_count": 27100,
"region_queries_count_wide": 74000,
"types": [
"ads_top",
"related_search"
],
"geo_names": [
],
}