serpstatr (version 0.3.0)

sst_pm_list_projects: List existing projects

Description

Gets a list of existing projects available for the users with their basic information.

Usage

sst_pm_list_projects(api_token, page = 1, size = 100, return_method = "list")

Value

Returns basic information on all the projects.

Arguments

api_token

(required) Serpstat API token from your profile.

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

0.

Examples

if (FALSE) {
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_pm_list_projects(
  api_token  = api_token,
  page       = 2,
  size       = 10
  )
}