serpstatr (version 0.3.0)

sst_sa_keywords: Phrase match keywords

Description

A full-text search to find all the keywords that match the queried term with a number of metrics for each keyword like search volume, CPC and competition level.

Usage

sst_sa_keywords(
  api_token,
  keyword,
  se,
  minusKeywords = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list"
)

Value

Returns a number of metrics for each keyword.

Arguments

api_token

(required) Serpstat API token from your profile.

keyword

(required) A keyword to search for.

se

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

minusKeywords

(optional) A vector of words. Keywords in response will not contain these words.

sort

(optional) A field to sort the response. See Sorting for more details.

filters

(optional) A list of filtering options. See Filtering for more details.

page

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

size

(optional) Response page size.

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 keyword in response.

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.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

if (FALSE) {
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_sa_keywords(
  api_token     = api_token,
  keyword       = 'serpstat',
  se            = 'g_us',
  minusKeywords = c('free'),
  sort          = list(keyword_length = 'asc'),
  page          = 2,
  size          = 10,
  return_method = 'df'
)$data
}