Domain competitors in V4 PPC (SerpstatDomainProcedure.getAdsCompetitors)

The SerpstatDomainProcedure.getAdsCompetitors method brings in the list of domain competitors in PPC. The data set is similar to the Competitors report in PPC research of the domain.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Optional	Default value	Value options
id	A request id: the response contains the same id. Enter any number (number) or text (string) value	no		1, test
method	API method name	no		SerpstatDomainProcedure.getAdsCompetitors
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	no
domain	Domain name	no		nike.com
se	ID of the search base to be searched	no		g_us
sort	Sort order of the results in the format: {{{field}}: {{order}}} field - field to sort by: * ads * keywords * intersected * missing_keywords order - sort direction (asc - ascending, desc - descending)	yes	{"relevance":"desc"}	{"ads":"desc"}
page	Page number in response	yes	1	"page": "1"
size	Number of results per page in response	yes	100	"size": "50" min: 50, max: 1000

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
domain	Domain
keywords	Number of paid keywords
ads	Number of ads.
intersected	Number of keywords bringing users to an analyzed domain and its competitor via paid results
missing_keywords	Number of keywords that competitor use in PPC and analyzed domain does not use.
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": "finishline.com",
    "keywords": 495,
    "ads": 453,
    "intersected": 57,
    "missing_keywords": 438
},

Example

Request data:

{
    "id": "1",
    "method": "SerpstatDomainProcedure.getAdsCompetitors",
    "params": {
        "domain": "nike.com",
        "se": "g_us",
        "page": "1",
        "size": "100", 
        "sort":{"ads":"desc"}
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "finishline.com",
                "keywords": 495,
                "ads": 453,
                "intersected": 57,
                "missing_keywords": 438
            },
            {
                "domain": "jordanusd.net",
                "keywords": 169,
                "ads": 60,
                "intersected": 2,
                "missing_keywords": 167
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 998969
        }
    }
}