ssar_sites_ranking_dist: Get Sites Ranking Distribution

Description Usage Arguments Value Examples

View source: R/get_sites_ranking_distribution.R

Description

This function returns all ranking distribution records for Google and Bing for a site with the specified id. The maximum date range can be no greater than 31 days.

Usage

1
2
3
4
5
6
7
ssar_sites_ranking_dist(
  siteid = NULL,
  fromdate = as.character(Sys.Date() - 31),
  todate = as.character(Sys.Date() - 1),
  subdomain = Sys.getenv("SSAR_SUBDOMAIN"),
  apikey = Sys.getenv("SSAR_APIKEY")
)

Arguments

siteid

Required The site id.

fromdate

Required Character string in the 'YYYY-MM-DD' format. Default is -31 days from today since the maximum date range can be no greater than 31 days.

todate

Required Character string in the 'YYYY-MM-DD' format. Default is yesterday.

subdomain

The account subdomain

apikey

The api key from the account

Value

A table with Google, GoogleBaseRank, and Bing ranking distributions by date

Examples

1
2
3
4
5
6
7
 
## Not run: 
ssar_sites_ranking_dist(siteid = {site_id}, #replace is your site id
                       fromdate = '2021-04-01',
                       todate = '2021-05-31')

## End(Not run)

statsearchanalyticsr documentation built on Sept. 28, 2021, 5:09 p.m.