sst_sa_keyword_trends: Keyword trends

View source: R/search_analytics.R

sst_sa_keyword_trendsR Documentation

Description

Returns monthly search volume trends for a list of keywords over a specified period (up to 48 months). You can send up to 100 keywords per request.

Usage

sst_sa_keyword_trends(
  keywords,
  se,
  months = 48,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

keywords

(required) A vector of keywords to analyze.

se

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

months

(optional) Number of months to get data for (up to 48). Default is 48.

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').

Value

Returns monthly search volume trends for each keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

10 credits per keyword that returned data. If no keywords returned data — 1 credit is charged for the whole request.

Examples

## Not run: 
sst_sa_keyword_trends(
  keywords      = c('seo', 'ppc', 'serpstat'),
  se            = 'g_us',
  months        = 12,
  return_method = 'df'
)$data

## End(Not run)

serpstatr documentation built on June 10, 2026, 1:06 a.m.