Top Pages (getTopPages)

The getTopPages method gives you a list of leading pages of the analyzed site by the number of backlinks with referring pages, domains and IPs. The data set is similar to the Top pages report.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter		Description	Default
id	required	A request id. Any number or string value is allowed.
method	required	API method name: SerpstatBacklinksProcedure.getTopPages
params	required	The array with parameters {...}, it lists all the following parameters and arrays.
query	required	A domain of the analyzed site. Specify the domain without http/ https и "/".
searchType	required	Search type: * domain_with_subdomains - domain with subdomains * domain - only domain
page	optional	A page number. Numbers are allowed.	1
size	optional	A number of results. Numbers are allowed.	100
sort	optional	Sort: * ips - the number of the referring IP addresses * count - the number of results in the given answer * domains - number of domains * url_to - the landing page * lastupdate - date of the first detection	lastupdate
order	optional	Order: * asc - in the ascending order * desc - in the descending order	desc
complexFilter	optional	Data filtering, entered as arrays. Available columns: * ips - the number of the referring IP addresses * count - the number of results in the given answer * domains - number of domains * url_to - the landing page * lastupdate - date of the first detection * lastupdate - link detection date. Value format: DD.MM.YYYY (01.01.2001) Compare type: * gt - greater than. Numbers are allowed * lt - less than. Numbers are allowed * gte - greater than or equal. Numbers are allowed * lte - less than or equal. Numbers are allowed * eq - exact match. Numbers and strings are allowed * neq - does not meet the requirement. Numbers and strings are allowed * between - between. Numbers are allowed * contains - contains. String values are allowed * notContains - does not contain. String values are allowed * startsWith - starts with. String values are allowed * endsWith - ends with. String values are allowed The first square brackets list the "OR" conditions. The second within the first are the "AND" conditions.

Response parameters
Parameter	Description
id	Request id
result	Contains the answer
data	Array with data
url	URL
ref_pages	A number of referring pages
ref_domains	A number of referring websites
ips	Referring IP addresses
url_to	Target page
summary_info	Array with data
page	Page number
total	Number of results for request
count	Number of results in this answer
left_lines	Left credits of lines for your pricing plan
sort	What data are sorted by
order	Data sorted in ascending / descending order

API limits are spent at 1 limit per line. Part of the API response for which you spend 1 limit:

        {
                "url": "/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/",
                "ref_pages": 114,
                "ref_domains": 69,
                "ips": 65,
                "urlTo": "https://serpstat.com/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/"
            }

Example PHP Python

Request data:

{
 "id": 1,
 "method": "SerpstatBacklinksProcedure.getTopPages",
 "params": {
     "query": "serpstat.com",
     "searchType": "domain_with_subdomains",
     "page": 1,
     "size": 2,
     "sort": "ips",
     "order": "desc",
     "complexFilter": [
           [
                {
                    "field": "path_to",
                    "compareType": "contains",
                    "value": [
                        "blog"
                    ]
                },
                {
                    "field": "url_to",
                    "compareType": "contains",
                    "value": [
                        "serpstat"
                    ]
                },
                {
                    "field": "count",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                },
                {
                    "field": "ips",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                },
                {
                    "field": "domains",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                }
            ]
        ]
  }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/",
                "ref_pages": 114,
                "ref_domains": 69,
                "ips": 65,
                "urlTo": "https://serpstat.com/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/"
            },
            {
                "url": "/ru/blog/",
                "ref_pages": 162,
                "ref_domains": 38,
                "ips": 41,
                "urlTo": "https://serpstat.com/ru/blog/"
            }
        ],
        "summary_info": {
            "left_lines": 999971,
            "page": 1,
            "count": 2,
            "total": 826,
            "sort": "ips",
            "order": "DESC"
        }
    }
}