External domains
The SerpstatBacklinksProcedure.getOutDomains method gives you a list of the domains that are linked to the analyzed site. The data set is similar to the External domains report.
Use case: with the SerpstatBacklinksProcedure.getOutDomains method, check what domains are linked to a competitor's domain and link your own domain to these domains.
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.getOutDomains |
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 - 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 | 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 | domain_rank | * domain_links - the number of links linking to the domain * domain_to - the domain to which the link from the analyzed * domain_rank - SDR (Serpstat Domain Rank), an indicator of domain authority |
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: * domain_links - the number of links to the domain * domain_from - domain * domain_rank - SDR (Serpstat Domain Rank), an indicator of domain authority 2) compareType - filter parameter: 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 |
domain_to | Domain to which the link from the analyzed |
domain_links | Number of links linking to the domain |
domain_rank | SDR (Serpstat Domain Rank) |
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:
{
"domain_to": "youtube.com",
"domain_links": 8835,
"domain_rank": 100
}
{
"id": 1,
"method": "SerpstatBacklinksProcedure.getOutDomains",
"params": {
"query": "serpstat.com",
"searchType": "domain_with_subdomains",
"sort": "domain_links",
"order": "desc",
"page": 1,
"size": 2,
"complexFilter": [
[
{
"field": "domain_to",
"compareType": "contains",
"value": [
".com"
]
},
{
"field": "domain_rank",
"compareType": "gte",
"value": [
"1"
]
},
{
"field": "domain_links",
"compareType": "gte",
"value": [
"1"
]
},
{
"additional_filters": "only_subdomains"
}
]
]
}
}
{
"id": "1",
"result": {
"data": [
{
"domain_to": "support.google.com",
"domain_links": 351,
"domain_rank": 0
},
{
"domain_to": "chrome.google.com",
"domain_links": 219,
"domain_rank": 0
}
],
"summary_info": {
"left_lines": 999818,
"page": 1,
"count": 2,
"total": 291,
"sort": "domain_links",
"order": "DESC"
}
}
}