statsearchanalyticsr (version 0.1.4)

ssar_rankings: Get Rankings

Description

Retrieve a table including metadata for all the sites in a particular project

Usage

ssar_rankings(
  keywordid = NULL,
  fromdate = NULL,
  todate = NULL,
  start = 0,
  results = 100,
  subdomain = Sys.getenv("SSAR_SUBDOMAIN"),
  apikey = Sys.getenv("SSAR_APIKEY")
)

Arguments

keywordid

The keyword id (required)

fromdate

Default is 100 most recent results (optional) Format is a string YYYY-MM-DD

todate

Default is most recent ranking day (optional) Format is a string YYYY-MM-DD

start

The default is 0 (zero indexed). The starting result for paginated requests

results

The default is 100

subdomain

The account subdomain

apikey

The api key from the account

Value

A dataframe of all rankings within a defined date range for a specific keyword

Examples

# NOT RUN {
ssar_rankings(keywordid = {keyword_id}, #replace with your keyword_id 
              fromdate = '2021-01-01', 
              todate = '2021-04-01')
# }
# NOT RUN {
# }