Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free.. Free Sign Up!

PPC Keyword Competitors List V4 (SerpstatKeywordProcedure.getAdsCompetitors)

The SerpstatKeywordProcedure.getAdsCompetitors method performs list of competitors in PPC for the given keyword. The data set is similar to the Competitors report in PPC research of the keywords.

General request parameters and instructions for using Serpstat API

Search databases available

Request parameters
Parameter Description Type Optional Default value Value Options
id A request id: the response contains the same id. Enter any number (number) or text (string) value int/string no 1, test
method API method name string no SerpstatKeywordProcedure.getAdsCompetitors
params The object with parameters {...}, it lists all the following parameters and arrays [...] array no
query Keyword by which competitors will be searched string no iphone
se Search engine ID (there are both Google and Yandex databases available, for example: g_us or y_157). string no g_us
page Page number in response  int yes 1 "page": "5"
pageSize Number of results per page in response int yes 100 "pageSize": "100"

min: 100, max: 1000
sort

Sort order of the results in the format:
{{{field}}: {{order}}}

field - field to sort by:
ads
all
common

order - sort direction (asc - ascending, desc - descending)
json object yes {"common": "desc"}

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data Array with data
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 Object with data
page Page number
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": "verizon.com",
    "ads": 8953,
    "all": 30855,
    "common": 1437
},

Example
Request data:
{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getAdsCompetitors",
 "params": {
   "query": "iphone",
   "se": "g_us",
   "page": "1",
   "pageSize": "100",
     "sort": {
            "common": "desc"
        }
    }
}

Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "verizon.com",
                "ads": 8953,
                "all": 30855,
                "common": 1437
            },
            {
                "domain": "apple.com",
                "ads": 4018,
                "all": 6164,
                "common": 488
            },
            {
                "domain": "t-mobile.com",
                "ads": 2623,
                "all": 3916,
                "common": 452
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 997925
        }
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Open support chat