sst_bl_domain_summary {serpstatr}

Backlinks summary

Description

Returns the overview of the backlinks profile for the domain.

Usage

sst_bl_domain_summary(
  api_token,
  domain,
  search_type = "domain",
  return_method = "list"
)

Arguments

api_token

(required) Serpstat API token from your profile.

domain

(required) A domain name to analyze.

search_type

(optional) Default value is 'domain' for domain only (site.com). 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.

Value

Returns aggregated backlinks data for the domain.

API docs

Check all the values for request and response fields here.

API rows consumption

1 per request.

Examples

## Not run: 
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_bl_domain_summary(
  api_token     = api_token,
  domain        = 'serpstat.com',
  search_type   = 'domain',
  return_method = 'list'
)$data

## End(Not run)