serpstatr (version 0.4.0)

sst_sa_domain_keywords_per_region: Number of keywords for each region for a domain

Description

Returns the number of keywords for each region for a domain. Regions with no keywords are not returned.

Usage

sst_sa_domain_keywords_per_region(
  domain,
  sort = "keywords_count",
  order = "desc",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Value

Returns a data frame with number of keywords for each region for a domain.

Arguments

domain

(required) A domain name to analyze.

sort

(optional) A field to sort the response. Allowed values: keywords_count, db_name, country_name_en, google_domain. Default: keywords_count.

order

(optional) The order of sorting. Allowed values: asc, desc. Default: desc.

return_method

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

api_token

(required) Serpstat API token from your profile. Default is Sys.getenv('SERPSTAT_API_TOKEN').

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned region.

Examples

if (FALSE) {
sst_sa_domain_keywords_per_region(
  domain        = 'serpstat.com',
  sort          = 'keywords_count',
  order         = 'desc',
  return_method = 'df'
)$data
}