Referring domains

The SerpstatBacklinksProcedure.getRefDomainsmethod gives you a list of referring domains of a site you analyze. The data set is similar to the Referring domains report. The data in this report and the Summary report may differ slightly due to the algorithm for quickly calculating summary data.

Referring domains

Use case: With the SerpstatBacklinksProcedure.getRefDomainsmethod method, check which sites link to your competitors so that you can place links to your site on those same sites.

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.getRefDomainsmethod
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 - domain only (site.com) domain_with_subdomains - domain with subdomains (subdomain.site.com)
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	check	* domain_links - the number of links to the domain * domain_from - donor * domain_rank - SDR (Serpstat Domain Rank), an indicator of domain authority * check - 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: * 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: * gt - greater than (int) * lt - less than (int) * gte - greater than or equal (int) * lte - less than or equal (int) * eq - exact match (int, string) * neq - does not meet the requirement (int, string) * between - between (int) * contains - contains (string) * notContains - does not contain (string) * startsWith - starts with (string) * endsWith - ends with (string) 2) value - filter value Quick filters: additional_filters - the following parameters are currently available: * no_subdomains - without links from subdomains of the analyzed domain * only_subdomains - shows only subdomains * only_hosts - shows only hosts * last_week - data for the last week 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_from	Referring domain
ref_pages	Number of referring pages of domain
domainRank	Serpstat Domain Rank (SDR)
summary_info	Array with data
left_lines	Left credits of lines for your pricing plan
page	Page number
total	Number of results for request
count	Number of results in this answer
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_from": "plus.google.com",
     "ref_pages": 5,
     "domainRank": 97
}

Example

Request data:

{
 "id": "1",
 "method": "SerpstatBacklinksProcedure.getRefDomains",
 "params": {
     "query" : "serpstat.com",
     "searchType": "domain",
     "order": "desc",
     "page": 1,
     "size": 2,
     "sort": "domain_rank",
     "complexFilter":[
            [
                {
                    "field": "domain_from",
                    "compareType": "contains",
                    "value": [
                        ".com"
                    ]
                },
                 {
                    "field": "domain_rank",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                },
                 {
                    "field": "domain_links",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                },
                 {
                    "additional_filters": "last_week"
                }
            ]
        ]
  }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain_from": "kunocreative.com",
                "ref_pages": 1,
                "domainRank": 58
            },
            {
                "domain_from": "geeknizer.com",
                "ref_pages": 2,
                "domainRank": 47
            }
        ],
        "summary_info": {
            "left_lines": 995119,
            "page": 1,
            "count": 2,
            "total": 17,
            "sort": "domain_rank",
            "order": "DESC"
        }
    }
}