Advertising report with specified name of domain V4 (SerpstatDomainProcedure.getAdKeywords)

SerpstatDomainProcedure.getAdKeywords — this report shows Ads by domain.

Request parameters:

Parameter	Value	Optional	Default value	Value Options
domain	Domain name	no		nike.com
se	ID of the search base to be searched	no		g_uk, g_ca, ...
url	Link to refine your search	yes	null	https://www.nike.com/
keywords	Array of key phrases to search for	yes	[]	["buy"]
minusKeywords	Negative keyword array	yes	[]	["vnike", "nnike"]
filters	Filter conditions	yes		{ "concurrency_from": "0", "concurrency_to": "1" }
sort	Order of sorting the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	yes	{"position": "asc", "region_queries_count":"desc"}	{"cost": "asc"}
page	Page number in response	yes	1	5
size	Number of results per page in response	yes	100	"size": {{page_size}} min: 1, max: 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

types

difficulty

geo_names

To filter the results, use the following parameters:

Parameter	Description	Possible values
position_from	min position for a keyword	1-100
position_to	max position for a keyword	1-100
queries_from	min number of monthly searches	0-100000000
queries_to	max number of monthly searches	0-100000000
cost_from	min CPC	0-200
cost_to	max CPC	0-200
concurrency_from	min level of competition	0-100
concurrency_to	max level of competition	0-100

Response metrics:

Metrics	Description
result	Contains the answer
total	Number of ads found that appear for queries containing the search word
hits	Conatains the answer
region_queries_count	Search volume in selected search engine database
region_queries_count_wide	Search volume (broad match)
region_queries_count_last	Search volume (last month)
domain	Domain
keyword_length	Number of words divided by space in a keyword
keyword	Query for which an ad is displayed in SERP
title	Ad Title
url	Ad URL
text	Ad text
found_results	Number of results found for ""keyword""
url_crc	CRC code (encryption method) for the ""url"" variable
CRC	Checksum for a quick search
cost	Cost per click, $
concurrency	Competition in Google Ads (0-100)
position	Ad position
date	Date of an SERP update
keywords_id	Keyword ID in our database
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)
left_lines	Number of remaining API queries

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:

{
"keyword": "gmail.coṃ",
"keyword_length": 1,
"domain": "google.com",
"subdomain": "gsuite.google.com",
"url": "https://gsuite.google.com/intl/ru/products/gmail/",
"title": "Рабочая почта Gmail от Google | Работайте там, где вам удобно",
"text": "Надежная почта, онлайн хранение, календарь, видеочат.",
"position": 1,
"type": 1,
"cost": 0.05,
"concurrency": 7,
"found_results": 13,
"region_queries_count": 74000,
"region_queries_count_wide": 0,
"types": [
  "pic",
  "ads_top"
],
"geo_names": [
 
]
}

Example PHP Python

Request data:

{
 "id": {{any_num_or_string}},
 "method": "SerpstatDomainProcedure.getAdKeywords",
 "params": {
   "domain": {{domain}},
   "se": {{search_engine}},
   (optional) "sort": { {{field}}: {{"asc"|"desc"}}},
   (optional) "url": {{url}},
   (optional) "keywords": [{{keyword}}, {{keyword}}, ...],
   (optional) "minusKeywords": [{{keyword}}, {{keyword}}, ...],
   (optional) "filters": { {{field_from}}: {{value}}, {{field_to}}: {{value}}},
   (optional) "page": {{page}},
   (optional) "size": {{page_size}}
 }
}

Response data:

{
  "id": {{your_num_or_string}},
  "result": {
    "data": [
      {
        "keyword": "gmail.coṃ",
        "keyword_length": 1,
        "domain": "google.com",
        "subdomain": "gsuite.google.com",
        "url": "https://gsuite.google.com/intl/ru/products/gmail/",
        "title": "Рабочая почта Gmail от Google | Работайте там, где вам удобно",
        "text": "Надежная почта, онлайн хранение, календарь, видеочат.",
        "position": 1,
        "type": 1,
        "cost": 0.05,
        "concurrency": 7,
        "found_results": 13,
        "region_queries_count": 74000,
        "region_queries_count_wide": 0,
        "types": [
          "pic",
          "ads_top"
        ],
        "geo_names": [
         
        ]
      },
      ................................................
    ],
    "summary_info": {
      "page": 1,
      "left_lines": 99268,
      "total": 3809
    }
  }
}