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. Outdates metrics are not removed from the method to maintain backward compatibility.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Value	Description
id	any number or string	Request id
method	SerpstatBacklinksProcedure.getTopPages	API method name
params	{...}	Array with parameters
query	domain	Domain of analyzed site
searchType	domain_with_subdomains \| url	Search type — domain with subdomains or url
(optional) page	number	Page number. Default: 1
(optional) size	number	Number of results. Default: 20

Response parameters
Parameter	Description
id	Request id
result	Contains the answer
data	Array with data
url_from	Linking page
url_to	Target page
nofollow	Nofollow (1) or follow (0) link
link_type	Link type (href, image, redirect, frame, rss, alternate, form, canonical)
links_ext	Number of external links from the referring page
link_text	Link anchor
first_seen	Link detection date
last_visited	Last date of crawling
str	Serpstat TrustRank (outdated)
spr	Serpstat PageRank (outdated)
organic	Organic or paid links (outdated)
ip	Referring IP addresses(outdated)
redirect	Redirect backlinks (outdated)
noindex	Noindex backlinks (outdated)
summary_info	Array with data
page	Page number
total	Number of results for request
count	Number of results in this answer
left_lines	Left limit of lines for your pricing plan
sort	What data is 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": "/about/administration/search-expert/",
                "ref_pages": 11,
                "ref_domains": 6,
                "ips": 7,
                "urlTo": "https://ucu.edu.ua/about/administration/search-expert/"
            }

Example

Request data:

{
    "id": 1,
    "method": "SerpstatBacklinksProcedure.getTopPages",
    "params": {
        "query": {{domain}},
        (optional) "page": {{page}},
        (optional) "size": {{size}}
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "/about/administration/search-expert/",
                "ref_pages": 11,
                "ref_domains": 6,
                "ips": 7,
                "urlTo": "https://ucu.edu.ua/about/administration/search-expert/"
            },
            {
                "url": "/en/",
                "ref_pages": 7,
                "ref_domains": 3,
                "ips": 7,
                "urlTo": "http://spm.ucu.edu.ua/en/"
            },
            {
                "url": "/program-highlights/2753/",
                "ref_pages": 7,
                "ref_domains": 6,
                "ips": 7,
                "urlTo": "http://journalism.ucu.edu.ua/program-highlights/2753/"
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 3295,
            "sort": "ips",
            "order": "DESC",
            "count": 100,
            "left_lines": 996396
        }
    }
}