serpstatr (version 0.3.0)

sst_sa_domains_info: Domains summary

Description

Returns the number of keywords for each domain in SEO and PPC, online visibility and other metrics.

Usage

sst_sa_domains_info(
  api_token,
  domains,
  se,
  sort = NULL,
  return_method = "list"
)

Value

Returns aggregated stats for each domain.

Arguments

api_token

(required) Serpstat API token from your profile.

domains

(required) A vector of domain names to analyze.

se

(required) Search engine alias (db_name) returned by sst_sa_database_info

sort

(optional) A field to sort the response. See Sorting 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 domain in request.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Examples

if (FALSE) {
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_sa_domains_info(
  api_token     = api_token,
  domains       = c('amazon.com', 'ebay.com'),
  se            = 'g_us',
  return_method = 'df'
)$data
}