Top Pages

The SerpstatBacklinksProcedure.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.

a list of leading pages of the analyzed site

Use case: With the SerpstatBacklinksProcedure.getTopPages method, check how many backlinks have different pages of the site to analyze it and optimize future promotion.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Required	Default value	Value options
id	A request id: the response contains the same id. Enter any number (number) or text (string) value	int/string	yes		Text or number value. For example: 1, test
method	API method name	string	yes		SerpstatBacklinksProcedure.getTopPages
params	The object with parameters {...}, it lists all the following parameters and arrays [...]		yes
query	Domain of the analyzed site. Specify the domain without http / https and «/»	string	yes		The text value of the domain being analyzed. For example: serpstat.com
searchType	Search modes for analysis	string	yes		* domain_with_subdomains - domain with subdomains * domain - only domain
page	A page number (number value)	int	no	1	any number value
size	A number of results (number value)	int	no	100	number value in the range of 1-1000
sort	Sorting the results	string	no	lastupdate	* 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
order	Order	string	no	desc	* asc - in the ascending order * desc - in the descending order

Filter conditions parameters

Parameter

Description

complexFilter

Data filtering, entered as arrays [...] with the following parameters:
1) 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)

2) 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)

3) value - filter value

Quick filters:
additional_filters - the following parameters are currently available:
* no_subdomains - without links from subdomains of the analyzed domain

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	Object 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: * 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"
                    ]
                },
                 {
                    "additional_filters": "no_subdomains"
                }
            ]
        ]
  }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "/ru/blog/kto-takoj-vebmaster/",
                "ref_pages": 122,
                "ref_domains": 75,
                "ips": 66,
                "urlTo": "https://serpstat.com/ru/blog/kto-takoj-vebmaster/"
            },
            {
                "url": "/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/",
                "ref_pages": 101,
                "ref_domains": 51,
                "ips": 47,
                "urlTo": "https://serpstat.com/blog/rank-your-page-for-a-whole-group-instead-of-a-single-keyword-with-our-new-keyword-clustering-tool/"
            }
        ],
        "summary_info": {
            "left_lines": 999814,
            "page": 1,
            "count": 2,
            "total": 871,
            "sort": "ips",
            "order": "DESC"
        }
    }
}