serpstatr (version 0.3.0)

sst_bl_referring_domains: Referring domains

Description

Returns the list of referring domains with main backlinks metrics for each domain.

Usage

sst_bl_referring_domains(
  api_token,
  domain,
  search_type = "domain",
  page = 1,
  size = 100,
  sort = "domain_rank",
  order = "desc",
  filter = NULL,
  return_method = "list"
)

Value

Returns aggregated backlinks data for each referring domain.

Arguments

api_token

(required) Serpstat API token from your profile.

domain

(required) A domain name to analyze.

search_type

(required) Default value is 'domain' for domain data only (site.com). See API docs for more details.

page

(optional) Response page number if there are many pages in response. Default is 1.

size

(optional) Response page size. Default is 100.

sort

(optional) A field to sort the response. Default is 'domain_rank'. See API docs for more details.

order

(optional) The order of sorting. Default is 'desc' for descending order. See API docs for more details.

filter

(optional) The nested list of filtering options. See API docs for more details.

return_method

(optional) Accepted values are 'list' (default) to return data object as list or 'df' to return data object as data.frame.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per each domain in response.

Sorting

You can sort the response using sort argument. The sorting order is defined using order argument.

Examples

if (FALSE) {
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_bl_referring_domains(
  api_token        = api_token,
  domain           = 'serpstat.com',
  page             = 1,
  size             = 100,
  sort             = 'domain_rank',
  order            = 'desc',
  filter           = NULL,
  return_method    = 'list'
)$data
}