Top pages

The SerpstatDomainProcedure.getTopUrls method returns website pages in hierarchical order. Also, it shows the number of keywords from Google top-100 for each URL, approximate traffic of the page and Facebook shares. The data set is similar to the Top pages report of the Domain Analysis.

General request parameters and instructions for using Serpstat API

Search databases available

The given method can work for prolonged periods of time owing to particularity of data collection. The results are sorted by the number of keywords in descending order by default.

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.getTopUrls
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: * organic_keywords * facebook_shares * potencial_traff order - sort direction (asc - ascending, desc - descending)	yes	{"organic_keywords":"desc"}	{"organic_keywords":"asc"}
filters	Filter conditions	yes		"url_prefix": "https://www.apple.com/shop/buy-ipad" "url_contain": "buy-ipad" "url_not_contain": "buy-watch" "url": "https://www.apple.com/shop/watch/accessories" "minus_url": "https://www.apple.com/shop/iphone/accessories" "pm_url": "https://www.apple.com/"
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
url	URL of the domain
organic_keywords	The number of keywords the URL ranks for in Google top-100 results
facebook_shares	The number of Facebook shares of the researched domain's page
potential_traff	The approximate traffic of the page by keywords depending on its volume and position
summary_info	Object with data
page	Page number
total	Total number of found results
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:

{
    "url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
    "organic_keywords": 39,
    "facebook_shares": 0,
    "potencial_traff": 540
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatDomainProcedure.getTopUrls",
 "params": {
   "domain": "nike.com",
   "se": "g_us",
   "sort": {"organic_keywords":"asc"},	
   "filters": {"url_contain": "nike-by-you"},
   "page": "1",
   "size": "50"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
                "organic_keywords": 39,
                "facebook_shares": 0,
                "potencial_traff": 540
            },
            {
                "url": "https://www.nike.com/w/nike-by-you-metcon-shoes-3yxqsz6ealhzy7ok",
                "organic_keywords": 40,
                "facebook_shares": 0,
                "potencial_traff": 511
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 490,
            "left_lines": 999217
        }
    }
}