External active links
The SerpstatBacklinksProcedure.getOutlinks method gives you a list of external backlinks of a site you analyze. The data set is similar to the Backlinks report.
Use case: with the SerpstatBacklinksProcedure.getOutlinks method, check the sites connected to the competitor's domain so you could establish a connection with these sites too to promote your site.
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.getOutlinks | |
| 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 - only domain (site.com) * domain_with_subdomains - domain with subdomains (subdomain.site.com) * URL - the specific URL (site.com/path/) * part_url - URL starts with (site.com/path/*) | |
| page | optional | A page number (number value) | 1 |
| size | optional | A number of results (number value) | 100 |
| sort | optional | Sorting: * url_from - the referring page * anchor - the anchor of the backlink * link_nofollow - link attributes * links_external - a number of outgoing links from the referring page * link_type - the type of incoming link * url_to - a landing page * check - date of the first detection | check |
| 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: * url_from - the referring page * anchor - the anchor of the backlink * link_nofollow - link attributes. Possible values: follow, nofollow, ugc, sponsored * links_external - the number of external links from the referring page * link_type - the type of the backlink. Possible values: text, redirect, iframe, form, canonical, rss, alternate, image * url_to - a landing page * check - link detection date. Value format: DD.MM.YYYY (01.01.2001) * compareType - filter parameter: The first square brackets list the "OR" conditions. The second within the first are the "AND" conditions. | |
| linkPerDomain | optional | Data acquisition mode: * 0 - one link from the page * 1 - one link from the domain | 1 |
| Response parameters | |
| Parameter | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| data | Array with data |
| url_from | Linking page |
| url_to | Target page |
| nofollow | Link attributes. If several are listed, they're separated by commas. Options: follow, nofollow, UGC, sponsored |
| 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 |
| date_del | The last date the link marked as lost by Serpstat bot |
| summary_info | Object with data |
| page | Page number |
| total | Number of results for the 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_from": "https://zerotoscale.com/episode-150-content-creation-process-checklist-vacation-recap/",
"url_to": "https://serpstat.com/",
"nofollow": "follow",
"link_type": "href",
"links_ext": 12,
"link_text": "SerpStat",
"first_seen": "2019-09-05 05:51:46",
"last_visited": "2019-12-11 18:41:42",
"date_del": "2019-12-11 18:41:42"
}Request data:
{
"id": 1,
"method": "SerpstatBacklinksProcedure.getOutlinks",
"params": {
"query": "serpstat.com",
"searchType": "domain",
"sort": "url_from",
"order": "desc",
"page": 1,
"size": 2,
"linkPerDomain": 1,
"complexFilter": [
[
{
"field": "url_from",
"compareType": "notContains",
"value": [
"7654765"
]
},
{
"field": "link_nofollow",
"compareType": "contains",
"value": [
"follow",
"nofollow",
"ugc",
"sponsored"
]
},
{
"field": "anchor",
"compareType": "notContains",
"value": [
"лопспрол"
]
},
{
"field": "check",
"compareType": "lte",
"value": [
"1.1.2030"
]
},
{
"field": "links_external",
"compareType": "between",
"value": [
"1",
"500"
]
}
],
[
{
"field": "links_external",
"compareType": "lte",
"value": [
"800"
]
}
]
]
}
}Response data:
{
"id": "1",
"result": {
"data": [
{
"url_from": "https://zerotoscale.com/episode-150-content-creation-process-checklist-vacation-recap/",
"url_to": "https://serpstat.com/",
"nofollow": "follow",
"link_type": "href",
"links_ext": 12,
"link_text": "SerpStat",
"first_seen": "2019-09-05 05:51:46",
"last_visited": "2019-12-11 18:41:42",
"date_del": "2019-12-11 18:41:42"
},
{
"url_from": "https://zen.yandex.ru/media/oxjornal/poleznye-instrumenty-i-saity-dlia-seospecialista-59f08c339d5cb307089b57bd",
"url_to": "https://serpstat.com/",
"nofollow": "follow",
"link_type": "href",
"links_ext": 14,
"link_text": "Serpstat",
"first_seen": "2019-03-20 12:08:14",
"last_visited": "2019-11-01 16:03:36",
"date_del": "2019-11-01 16:03:36"
}
],
"summary_info": {
"left_lines": 999995,
"page": 1,
"count": 2,
"total": 1440,
"sort": "url_from",
"order": "DESC"
}
}
}