serpstatr (version 0.3.0)

sst_rt_project_regions: Get all regions for the project

Description

In Serpstat you are able to track ranking of your website in multiple regions. This method returns all the regions in your Serpstat project. You will need the results of this method to get rankings in selected region.

Usage

sst_rt_project_regions(api_token, project_id, return_method = "list")

Value

Returns the regions of the project with their ID, state (active or not) and other region attributes.

Arguments

api_token

(required) Serpstat API token from your profile.

project_id

(required) The ID of your project in Serpstat. You can find this ID in the URL of any rank tracker report. As an example, in https://serpstat.com/rank-tracker/keywords/12345/positions?get_params the ID would be 12345.

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')
project_id <- 12345
sst_rt_project_regions(api_token = api_token, project_id = project_id)
}