Domain competitors in V4 PPC (SerpstatDomainProcedure.getAdsCompetitors)

SerpstatDomainProcedure.getAdsCompetitors — this method brings in the list of domain competitors from PPC.

Request parameters:

Parameter	Description	Optional	Default value	Value options
domain	Domain name	no	-	allo.ua
se	ID of the search base to be searched	no	-	g_ua
sort	Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by order - sort direction (asc - ascending, desc - descending)	yes	{"relevance":"desc"}	{"ads":"desc"}
page	Page number in response	yes	1	5
size	Number of results per page in response	yes	100	50-1000

Sorting results is possible by the following fields:

Parameter

keywords

ads

intersected

relevance

Response metrics:

Metrics	Description
result	Contains the answer
domain	Domain
keywords	Number of keywords found in the chosen search engine
ads	Number of ads
intersected	Number of domain keywords that contain a target keyword
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:

{
  "domain": "eldorado.ua",
  "keywords": 1155,
  "ads": 1319,
  "intersected": 207,
  "missing_keywords": 948
},

Example

Request data:

{
    "id": 1,
    "method": "SerpstatDomainProcedure.getAdsCompetitors",
    "params": {
        "domain": "allo.ua",
        "se": "g_ua",
        "sort":{
            "ads":"desc"
        }
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "rozetka.com.ua",
                "keywords": 63725418,
                "ads": 49534,
                "intersected": 1222,
                "missing_keywords": 57272
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 9999817
        }
    }
}