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: the response contains the same id. Enter any number (number) or text (string) value
method	required	API method name: SerpstatBacklinksProcedure.getTopPages
params	required	The object with parameters {...}, it lists all the following parameters and arrays [...]
query	required	A domain of the analyzed site. Specify the domain without HTTP, HTTPS, and "/"
searchType	required	Search type: * domain_with_subdomains - domain with subdomains * domain - only domain
page	optional	A page number (number value)	1
size	optional	A number of results (number value)	100
sort	optional	Sorting: * 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 [...] * field - filter parameter Available filtering: * 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) * compareType - filter parameter: * gt - greater than (number value) * lt - less than (number value) * gte - greater than or equal (number value) * lte - less than or equal (number value) * eq - exact match (number or text value) * neq - does not meet the requirement (number or text value) * between - between (number value) * contains - contains (text value) * notContains - does not contain (text value) * startsWith - starts with (text value) * endsWith - ends with (text value) * value - filter value The first square brackets list the "OR" conditions. The second within the first are the "AND" conditions.

Response parameters
Parameter	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
url	URL of a page
ref_pages	A number of referring pages
ref_domains	A number of referring websites
ips	Referring IP addresses
url_to	Target page
summary_info	Objectwith 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: * asc - in the ascending order * desc - in the descending order

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

{
     "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

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"
        }
    }
}