Top pages

The SerpstatDomainProcedure.getTopUrls method returns website pages that rank for the largest amount of the analyzed keyword variations and have the highest traffic.
The data set is similar to the Top pages report of the Keyword Analysis.

General request parameters and instructions for using Serpstat API
Search databases available

Request parameters
Parameter	Description	Type	Required	Default value	Value options
id	A request id: the response contains the same id.	int/string	yes		Any text or number value. For example: 1, test, тест
method	API method name	string	yes		SerpstatDomainProcedure.getTopUrls
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	yes
keyword	Keyword to search for	string	yes		Any text value. For example: rebook
se	ID of the search base to be searched	string	yes		g_us
page	Page number	int	no	1	Any number value
page_size	Number of results per page	int	no	20	Number value. Possible values: 20, 50, 100, 200, 500
sort	Sorting by parameters	string	no	keywords	"keywords" — Sorting by the number of keywords
order	Sorting order	string	no	desc	"desc" — descending order, "asc" — ascending order

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
urls	Array with data
url	URL of the searched keyword
keywords	General number of keywords in Google top-100 of the mentioned URL
traff	Estimated search traffic based on keyword positions and search volume
fbShares	Number of shares in Facebook
summary_info	Object with data
left_lines	API credits remaining
keyword	Analyzed keyword
se	Used search base
page	Page number
page_size	Size number
sort	Sorting of the request
order	Used sorting order
total_urls	Number of found results

Credits: 1 request charges 1 API credit.

Example

Request data:

{
"id": "1",
"method": "SerpstatKeywordProcedure.getTopUrls",
"params": {
"keyword": "rebook",
"se": "g_us",
"page": 1,
"page_size": 20,
"sort": "keywords",
"order": "desc"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "urls": [
            {
                "url": "https://www.cnet.com/how-to/easily-reschedule-a-canceled-or-delayed-flight-with-freebird/",
                "keywords": 3,
                "traff": 0,
                "fbShares": "1"
            },
            {
                "url": "http://money.com/money/5086004/winter-storm-grayson-flight-cancellations/",
                "keywords": 3,
                "traff": 0,
                "fbShares": "7"
            },
        ],
        "summary_info": {
            "left_lines": 9999894,
            "keyword": "rebook",
            "se": "g_us",
            "page": 1,
            "pageSize": 20,
            "sort": "keywords",
            "order": "desc",
            "total": 303
        }
    }
}