ssar_sites: Get Sites

Description Usage Arguments Value Examples

View source: R/get_sites.R

Description

Retrieve a table of all the sites and metadata in a specified project

Usage

1
2
3
4
5
6
7
ssar_sites(
  projectid = NULL,
  start = NULL,
  results = 100,
  subdomain = Sys.getenv("SSAR_SUBDOMAIN"),
  apikey = Sys.getenv("SSAR_APIKEY")
)

Arguments

projectid

The project id. If not provided then all sites will be returned.

start

If more than results are available use start as pagination. Index starts at 0 (default).

results

Default is 100. Max is 5000.

subdomain

The account subdomain

apikey

The api key from the account

Value

A table of the site information within a project

Examples

1
2
3
4
5
## Not run: 
ssar_sites(projectid = {project_id}, #replace with your project id
           results = 300)

## End(Not run)

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