Package {serpstatr}

serpstatr: Serpstat API wrapper for R.

Description

The serpstatr package covers main Serpstat API methods. All the names of the functions start with sst_ to reduce the name conflict with other packages.

Details

All the required arguments are checked by the API endpoint. So you would not get an error in R but the response would contain error object.

Functions naming

The names of the package functions start with sst_sa_

• sst_sa_database_info

• sst_sa_stats

Author(s)

Maintainer: Alex Danilin alexnikdanilin@gmail.com

Authors:

• Alex Danilin alexnikdanilin@gmail.com

See Also

Useful links:

• https://api-docs.serpstat.com/docs/serpstat-public-api/jenasqbwtxdlr-introduction-to-serpstat-api

export

Description

export

Usage

sst_au_export(
  report_id,
  export_type,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getAudit

Description

getAudit

Usage

sst_au_get_audit(
  report_id,
  compare_report_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getCategoriesStatistic

Description

getCategoriesStatistic

Usage

sst_au_get_categories_statistic(
  report_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getDefaultSettings

Description

getDefaultSettings

Usage

sst_au_get_default_settings(
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getErrorElements

Description

getErrorElements

Usage

sst_au_get_error_elements(
  report_id,
  compare_report_id,
  project_id,
  error_name,
  mode = NULL,
  limit = NULL,
  offset = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getErrorRows

Description

getErrorRows

Usage

sst_au_get_error_rows(
  report_id,
  error,
  compare_report_id = NULL,
  mode = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getHistoryByCountError

Description

getHistoryByCountError

Usage

sst_au_get_history_by_count_error(
  project_id,
  error_name,
  limit,
  offset,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getList

Description

getList

Usage

sst_au_get_list(
  project_id,
  limit = NULL,
  offset = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getPageAudit

Description

getPageAudit

Usage

sst_au_get_page_audit(
  page_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getPagesList

Description

getPagesList

Usage

sst_au_get_pages_list(
  limit = NULL,
  offset = NULL,
  team_member_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getReportWithoutDetails

Description

getReportWithoutDetails

Usage

sst_au_get_report_without_details(
  report_id,
  compare_report_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getReportsListByPage

Description

getReportsListByPage

Usage

sst_au_get_reports_list_by_page(
  page_id,
  limit = NULL,
  offset = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getScanUserUrlList

Description

getScanUserUrlList

Usage

sst_au_get_scan_user_url_list(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getSettings

Description

getSettings

Usage

sst_au_get_settings(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getSubElementsByCrc

Description

getSubElementsByCrc

Usage

sst_au_get_sub_elements_by_crc(
  report_id,
  project_id,
  error_name,
  crc,
  compare_report_id = NULL,
  mode = NULL,
  limit = NULL,
  offset = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Website audit summary

Description

Returns the basic stats for the finished audit returns, including number of checked pages, issues by priority, domain optimization score.

Usage

sst_au_get_summary(
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  report_id = NULL,
  return_method = "list"
)

Arguments

Value

Returns the basic metrics for audited website.

API docs

Check all the values for request and response fields here.

API credits consumption

0.

Examples

## Not run: 
sst_au_get_summary(
  report_id = report_id
  )$data

## End(Not run)

pageNames

Description

pageNames

Usage

sst_au_page_names(
  team_member_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

remove

Description

remove

Usage

sst_au_remove(
  page_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

rescan

Description

rescan

Usage

sst_au_rescan(
  page_id,
  name,
  user_agent,
  http_auth_login = NULL,
  http_auth_pass = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

scan

Description

scan

Usage

sst_au_scan(
  name,
  url,
  user_agent,
  http_auth_login = NULL,
  http_auth_pass = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

setSettings

Description

setSettings

Usage

sst_au_set_settings(
  project_id,
  main_settings,
  mail_trigger_settings,
  schedule_settings,
  scan_setting,
  dont_scan_keywords_block = NULL,
  only_scan_keywords_block = NULL,
  base_auth_block = NULL,
  errors_settings = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Start a website audit

Description

Starts a project website audit with the current audit settings. Uses default audit settings if no settings were changed.

Usage

sst_au_start(
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  project_id = NULL,
  return_method = "list"
)

Arguments

Value

Returns the ID of the audit report.

API docs

Check all the values for request and response fields here.

API credits consumption

1 audit credit for each checked page.

Examples

## Not run: 
sst_au_start(
  project_id = 12345
  )$data$reportId

## End(Not run)

stop

Description

stop

Usage

sst_au_stop_page(
  page_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

stop

Description

stop

Usage

sst_au_stop_site(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

userLog

Description

userLog

Usage

sst_au_user_log(
  report_id = NULL,
  page_size = 100,
  page = 1,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Referring anchors

Description

Returns anchors of backlinks for the analyzed domain.

Usage

sst_bl_anchors(
  domain,
  search_type = "domain",
  anchor = NULL,
  count = NULL,
  sort = NULL,
  order = NULL,
  page = 1,
  size = 100,
  filter = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns anchors data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned anchor.

Backlinks changes history

Description

Returns history of backlinks changes (new and lost backlinks) over time.

Usage

sst_bl_changes_history(
  domain,
  search_type = "domain",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns changes history data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Backlinks summary

Description

Returns the overview of the backlinks profile for the domain.

Usage

sst_bl_domain_summary(
  domain,
  search_type = "domain",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns aggregated backlinks data for the domain.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Examples

## Not run: 
sst_bl_domain_summary(
  domain        = 'serpstat.com',
  search_type   = 'domain',
  return_method = 'list'
)$data

## End(Not run)

Intersecting referring domains

Description

Returns referring domains that link to comparison domains but not to the target domain.

Usage

sst_bl_domains_intersection(
  domain,
  compare_domains,
  sort = NULL,
  order = NULL,
  page = 1,
  size = 100,
  filter = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns common referring domains data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per each referring domain in response.

Intersecting referring domains summary

Description

Returns summary of intersecting referring domains.

Usage

sst_bl_domains_intersection_summary(
  domain,
  compare_domains,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns summary of common referring domains.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Lost backlinks

Description

Returns lost backlinks for the analyzed domain.

Usage

sst_bl_lost_backlinks(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns lost backlinks data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned lost backlink.

Lost outgoing links

Description

Returns lost outgoing links from the analyzed domain/page.

Usage

sst_bl_lost_outlinks(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns lost outgoing links data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned lost outgoing link.

New backlinks

Description

Returns new backlinks for the analyzed domain.

Usage

sst_bl_new_backlinks(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns new backlinks data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned new backlink.

Outgoing domains

Description

Returns domains linked from the analyzed domain.

Usage

sst_bl_out_domains(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns outgoing domains data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned outgoing domain.

Outgoing backlinks threats

Description

Returns domain-level malicious or vulnerability threats in outgoing links.

Usage

sst_bl_out_threats(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns outgoing threats data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned threat.

Outgoing backlinks threats links

Description

Returns link-level malicious or vulnerability threats in outgoing links.

Usage

sst_bl_out_threats_links(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns outgoing malicious links data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned malicious link.

Outgoing links

Description

Returns outgoing links from the analyzed domain/page.

Usage

sst_bl_outlinks(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns outgoing links data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned outgoing link.

Redirected domains

Description

Returns domains from which redirects were performed to the analyzed domain.

Usage

sst_bl_redirected_domains(
  domain,
  sort = NULL,
  order = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns redirected domains data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned redirected domain.

Referring domains

Description

Returns the list of referring domains with main backlinks metrics for each domain.

Usage

sst_bl_referring_domains(
  domain,
  search_type = "domain",
  page = 1,
  size = 100,
  sort = "domain_rank",
  order = "desc",
  filter = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns aggregated backlinks data for each referring domain.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per each domain in response.

Sorting

You can sort the response using sort argument. The sorting order is defined using order argument.

Examples

## Not run: 
sst_bl_referring_domains(
  domain           = 'serpstat.com',
  page             = 1,
  size             = 100,
  sort             = 'domain_rank',
  order            = 'desc',
  filter           = NULL,
  return_method    = 'list'
)$data

## End(Not run)

SDR distribution

Description

Returns distribution of SDR (Serpstat Domain Rank) for the referring domains.

Usage

sst_bl_sdr_distribution(
  domain,
  search_type = "domain",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns SDR distribution data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Backlinks threats

Description

Returns domain-level malicious or vulnerability threats found in the backlinks profile.

Usage

sst_bl_threats(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns threats data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned threat.

Backlinks threats links

Description

Returns link-level malicious or vulnerability threats found in the backlinks profile.

Usage

sst_bl_threats_links(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  links_per_domain = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns malicious links data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned malicious link.

TLD distribution

Description

Returns distribution of top-level domains (TLDs) for the referring domains.

Usage

sst_bl_tld_distribution(
  domain,
  search_type = "domain",
  language = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns TLD distribution data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Top anchors

Description

Returns top anchors for the analyzed domain.

Usage

sst_bl_top_anchors(
  domain,
  search_type = "domain",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns top anchors data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per request.

Top pages by backlinks

Description

Returns top pages of the analyzed domain by backlinks count.

Usage

sst_bl_top_pages(
  domain,
  search_type = "domain",
  sort = NULL,
  order = NULL,
  filter = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns top pages data.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned page.

Make a request to Serpstat API endpoint

Description

Make a request to Serpstat API endpoint

Usage

sst_call_api_method(api_token, api_method, api_params = NULL)

Arguments

Value

The list with a response data.

getAuditStats

Description

getAuditStats

Usage

sst_cr_get_audit_stats(
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addTask

Description

addTask

Usage

sst_dc_add_task(
  domains,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getTask

Description

getTask

Usage

sst_dc_get_task(
  task_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getTaskList

Description

getTaskList

Usage

sst_dc_get_task_list(
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Convert list of lists to data.frame

Description

API response might contain nested lists with different number of elements. This function fills missing elements and combine lists to a data.frame.

Usage

sst_lists_to_df(lists, fill = NA)

Arguments

Value

A data.frame with all missing values filed with specified value.

Examples

sst_lists_to_df(
  lists = list(
    first_list  = list(a = 1, b = 2),
    second_list = list(a = 2, c = 3)
  ),
  fill  = 'empty'
)

Create a new project

Description

Creates a new project in Serpstat.

Usage

sst_pm_create_project(
  domain,
  name,
  groups = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the project ID for the created project.

API docs

Check all the values for request and response fields here.

API credits consumption

1 project credit.

Examples

## Not run: 
sst_pm_create_project(
  domain    = 'serpstat.com',
  name      = 'Serpstat'
  )$data$project_id

## End(Not run)

Delete the existing project

Description

Deletes the existing project in Serpstat by project ID.

Usage

sst_pm_delete_project(
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  project_id = NULL,
  return_method = "list"
)

Arguments

Value

Returns the state of the deletion operation.

API docs

Check all the values for request and response fields here.

API credits consumption

returns 1 project credit.

Examples

## Not run: 
sst_pm_delete_project(
  project_id = 12345
  )

## End(Not run)

List existing projects

Description

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

Usage

sst_pm_list_projects(
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns basic information on all the projects.

API docs

Check all the values for request and response fields here.

API credits consumption

0.

Examples

## Not run: 
sst_pm_list_projects(
  page       = 2,
  size       = 10
  )

## End(Not run)

Preprocess the API response

Description

Every API call returns a JSON object. This object is transformed to a list. Depending on return_method parameter the data element of this list will be a list or data.frame.

Usage

sst_return_check(response_content, return_method)

Arguments

Value

response_content with a data object as list or data.frame.

addProjectCompetitor

Description

addProjectCompetitor

Usage

sst_rt_add_project_competitor(
  project_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addProjectKeywords

Description

addProjectKeywords

Usage

sst_rt_add_project_keywords(
  project_id,
  keywords,
  tags = NULL,
  url = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addProjectMirror

Description

addProjectMirror

Usage

sst_rt_add_project_mirror(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addProjectRegion

Description

addProjectRegion

Usage

sst_rt_add_project_region(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addRtProject

Description

addRtProject

Usage

sst_rt_add_rt_project(
  name,
  domain,
  group = NULL,
  parsing_type = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Get the data on competitors in search results

Description

This method method returns the competing in top20 search results domains that rank for at least two keywords that are added the project.

Usage

sst_rt_competitors(
  project_id,
  region_id,
  date_from = Sys.Date() - 8,
  date_to = Sys.Date() - 1,
  domains = NULL,
  sort = "sum_traffic",
  sort_range = "top1",
  order = "desc",
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns traffic and keywords distributions, average positions of the domains by date.

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
project_id <- 12345
region_id  <- sst_rt_competitors(
  project_id = project_id
  )$data$regions[[1]]$id
sst_rt_competitors(
  api_token     = api_token,
  project_id    = project_id,
  region_id     = region_id,
  date_from     = '2020-12-01',
  date_to       = '2020-12-30',
  domains       = c('serpstat.com', 'serpstatbot.com'),
  sort          = 'sum_traffic',
  sort_range    = 'top1',
  order         = 'desc',
  page          = 1,
  size          = 20,
  return_method = 'list'
)

## End(Not run)

createAndRunProjectTracking

Description

createAndRunProjectTracking

Usage

sst_rt_create_and_run_project_tracking(
  domain,
  keywords,
  name = NULL,
  group = NULL,
  regions = NULL,
  parsing_type = NULL,
  mirrors = NULL,
  schedule = NULL,
  competitors = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

createProjectTags

Description

createProjectTags

Usage

sst_rt_create_project_tags(
  project_id,
  tags,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deleteProjectCompetitor

Description

deleteProjectCompetitor

Usage

sst_rt_delete_project_competitor(
  competitor_uuid,
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deleteProjectKeywords

Description

deleteProjectKeywords

Usage

sst_rt_delete_project_keywords(
  project_id,
  keyword_ids,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deleteProjectMirror

Description

deleteProjectMirror

Usage

sst_rt_delete_project_mirror(
  project_id,
  mirror_uuid,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deleteProjectRegion

Description

deleteProjectRegion

Usage

sst_rt_delete_project_region(
  project_id,
  region_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deleteProjectTags

Description

deleteProjectTags

Usage

sst_rt_delete_project_tags(
  project_id,
  tag_uuids,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getCities

Description

getCities

Usage

sst_rt_get_cities(
  district_id,
  search_engine,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getCountries

Description

getCountries

Usage

sst_rt_get_countries(
  search_engine,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getDistricts

Description

getDistricts

Usage

sst_rt_get_districts(
  country_id,
  search_engine,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectCompetitors

Description

getProjectCompetitors

Usage

sst_rt_get_project_competitors(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectKeywords

Description

getProjectKeywords

Usage

sst_rt_get_project_keywords(
  project_id,
  keyword_ids = NULL,
  search_string = NULL,
  tags = NULL,
  page = 1,
  size = 100,
  sort = NULL,
  order = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectMirrors

Description

getProjectMirrors

Usage

sst_rt_get_project_mirrors(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectPositions

Description

getProjectPositions

Usage

sst_rt_get_project_positions(
  project_id,
  project_region_ids,
  domains = NULL,
  filter = NULL,
  page = 1,
  page_size = 100,
  date_from = NULL,
  date_to = NULL,
  sort = NULL,
  order = NULL,
  sort_region = NULL,
  tag_ids = NULL,
  keyword_ids = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectRegions

Description

getProjectRegions

Usage

sst_rt_get_project_regions(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectStatus

Description

getProjectStatus

Usage

sst_rt_get_project_status(
  project_id,
  region_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjectTags

Description

getProjectTags

Usage

sst_rt_get_project_tags(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getProjects

Description

getProjects

Usage

sst_rt_get_projects(
  page = 1,
  page_size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getRtProject

Description

getRtProject

Usage

sst_rt_get_rt_project(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getRtSchedule

Description

getRtSchedule

Usage

sst_rt_get_rt_schedule(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Get ranking history for the domain or URL in selected search region

Description

This method method returns the rankings for specified domain is selected search region.

Usage

sst_rt_positions_history(
  project_id,
  region_id,
  date_from = Sys.Date() - 8,
  date_to = Sys.Date() - 1,
  keywords = NULL,
  url = NULL,
  tags = FALSE,
  sort = "keyword",
  order = "desc",
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns positions of selected domain in search engine results in selected region with corresponding URLs for these positions.

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
project_id <- 12345
region_id  <- sst_rt_project_regions(
  project_id = project_id
  )$data$regions[[1]]$id
sst_rt_positions_history(
  api_token     = api_token,
  project_id    = project_id,
  region_id     = region_id,
  date_from     = '2020-12-01',
  date_to       = '2020-12-30',
  keywords      = c('seo', 'ppc', 'serpstat'),
  url           = 'serpstat.com',
  sort          = 'keyword',
  order         = 'desc',
  page          = 1,
  size          = 100,
  return_method = 'list'
)

## End(Not run)

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(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

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

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
sst_rt_project_regions(project_id = 12345)

## End(Not run)

runProjectTracking

Description

runProjectTracking

Usage

sst_rt_run_project_tracking(
  project_id,
  keyword_ids = NULL,
  region_ids = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Get search results history in search region by keywords

Description

This method returns top 100 search results in Google.

Usage

sst_rt_serp_history(
  project_id,
  region_id,
  date_from = Sys.Date() - 8,
  date_to = Sys.Date() - 1,
  keywords = NULL,
  tags = FALSE,
  sort = "keyword",
  order = "desc",
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the search engine results for specific dates and region including positions and URLs.

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
project_id <- 12345
region_id  <- sst_rt_project_regions(
  project_id = project_id
  )$data$regions[[1]]$id
sst_rt_serp_history(
  api_token     = api_token,
  project_id    = project_id,
  region_id     = region_id,
  date_from     = '2020-12-01',
  date_to       = '2020-12-30',
  keywords      = c('seo', 'ppc', 'serpstat'),
  sort          = 'keyword',
  order         = 'desc',
  page          = 1,
  size          = 100,
  return_method = 'list'
)

## End(Not run)

setRtSchedule

Description

setRtSchedule

Usage

sst_rt_set_rt_schedule(
  project_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

updateProjectKeywords

Description

updateProjectKeywords

Usage

sst_rt_update_project_keywords(
  project_id,
  keywords,
  regions = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Top Domains in Market Category

Description

Returns top-performing domains in a specific market category with their SEO metrics.

Usage

sst_sa_category_top_domains(
  category_id,
  se,
  sort = NULL,
  order = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns top-performing domains for the category.

API docs

Check all the values for request and response fields here.

API credits consumption

1 credit per row in response.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_category_top_domains(
  category_id   = '.1.',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

List all Serpstat databases

Description

In every request to get data from search analytics API you must set se parameter to specify from what country do you want to get the data. This method returns all acceptable values for se parameter with corresponding country names.

Usage

sst_sa_database_info(
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  return_method = "list"
)

Arguments

Value

Returns country name, se parameter value and local search engine domain name for each country.

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
sst_sa_database_info()$data

## End(Not run)

Domain advertising competitors

Description

Returns competing domains in paid search (PPC) results.

Usage

sst_sa_domain_ad_competitors(
  domain,
  se,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list of PPC competitors with their metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned competitor.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Examples

## Not run: 
sst_sa_domain_ad_competitors(
  domain        = 'serpstat.com',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Domain advertising keywords

Description

Returns keywords in paid search results and advertising listings for a specific domain.

Usage

sst_sa_domain_ad_keywords(
  domain,
  se,
  url = NULL,
  keywords = NULL,
  minus_keywords = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list of PPC keywords with their metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per keyword in response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_ad_keywords(
  domain         = 'serpstat.com',
  se             = 'g_us',
  url            = 'https://serpstat.com/',
  keywords       = list('google'),
  minus_keywords = list('download'),
  page           = 1,
  size           = 100,
  return_method  = 'df'
)$data

## End(Not run)

AI Overview Brand Opportunities

Description

Returns a paginated list of keywords with AI Overview (AIO) data for a given brand and list of domains.

Usage

sst_sa_domain_aio_brand_opportunities(
  domains,
  brand,
  search_engine = "g_us",
  page = 1,
  page_size = 100,
  sort = NULL,
  order = NULL,
  filters = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a paginated list of keywords with AIO data.

API docs

Check all the values for request and response fields here.

API credits consumption

2 credits per row in response.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_aio_brand_opportunities(
  domains       = c('amazon.com'),
  brand         = 'Amazon',
  search_engine = 'g_us',
  page          = 1,
  page_size     = 100,
  return_method = 'df'
)$data

## End(Not run)

AI Overview Brand Summary

Description

Returns a summary of AI Overview (AIO) presence for a given brand and list of domains.

Usage

sst_sa_domain_aio_summary(
  domains,
  brand,
  search_engine = "g_us",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a summary of AIO brand presence.

API docs

Check all the values for request and response fields here.

API credits consumption

5 credits per request.

Examples

## Not run: 
sst_sa_domain_aio_summary(
  domains       = c('amazon.com'),
  brand         = 'Amazon',
  search_engine = 'g_us',
  return_method = 'df'
)$data

## End(Not run)

Traffic in all regions for a domain

Description

Returns search traffic info for a domain across all databases. Databases with no keywords are not shown.

Usage

sst_sa_domain_all_regions_traffic(
  domain,
  sort = c("traff"),
  order = "desc",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns traffic data for all regions.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per region in response.

Examples

## Not run: 
sst_sa_domain_all_regions_traffic(
  domain        = 'serpstat.com',
  sort          = c('traff'),
  order         = 'desc',
  return_method = 'df'
)$data

## End(Not run)

Domain competitors in organic search

Description

Returns organic competitors for the domain with their key metrics. This is implemented using the newer SerpstatDomainProcedure.getOrganicCompetitorsPage API.

Usage

sst_sa_domain_competitors(
  domain,
  se,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list of organic competitors with their SEO metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned page.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Examples

## Not run: 
sst_sa_domain_competitors(
  domain        = 'serpstat.com',
  se            = 'g_us',
  sort          = list(relevance = 'desc'),
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Export domain positions

Description

Export a complete report of a domain's keyword positions in search results.

Usage

sst_sa_domain_export_positions(
  domain,
  se,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a complete report of domain positions (often in CSV format).

API docs

Check all the values for request and response fields here.

API credits consumption

1 per row in response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_export_positions(
  domain        = 'serpstat.com',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Domain history

Description

Returns historical metrics for the domain with about two weeks between measurements.

Usage

sst_sa_domain_history(
  domain,
  se,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  during_all_time = TRUE,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a number of metrics for each date for the domain.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per date in the response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_history(
  domain        = 'serpstat.com',
  se            = 'g_us',
  sort          = list(date = 'desc'),
  filters       = list(traff_from = 20000),
  page          = 2,
  size          = 10,
  return_method = 'df'
)$data

## End(Not run)

Domain organic keywords

Description

Returns up to 60 000 organic keywords from selected region for the domain with a number of metrics for each keyword.

Usage

sst_sa_domain_keywords(
  domain,
  se,
  url = NULL,
  keywords = NULL,
  minusKeywords = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a number of metrics for each keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per keyword in response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_keywords(
  domain        = 'serpstat.com',
  se            = 'g_us',
  sort          = list(keyword_length = 'desc'),
  url           = 'https://serpstat.com/',
  keywords      = list('google'),
  minusKeywords = list('download'),
  filters       = list(queries_from = 0,
                       queries_to   = 10),
  page          = 2,
  size          = 10,
  return_method = 'df'
)$data

## End(Not run)

Domain keywords by language

Description

Returns keywords which the analyzed domain ranks for, enriched with the detected language of each keyword.

Usage

sst_sa_domain_keywords_by_language(
  domain,
  se,
  with_subdomains = TRUE,
  url = NULL,
  keywords = NULL,
  minus_keywords = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns keywords with language detection info.

API docs

Check all the values for request and response fields here.

API credits consumption

1 credit per member of data object array in response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_keywords_by_language(
  domain        = 'serpstat.com',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Number of keywords for each region for a domain

Description

Returns the number of keywords for each region for a domain. Regions with no keywords are not returned.

Usage

sst_sa_domain_keywords_per_region(
  domain,
  sort = "keywords_count",
  order = "desc",
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a data frame with number of keywords for each region for a domain.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned region.

Examples

## Not run: 
sst_sa_domain_keywords_per_region(
  domain        = 'serpstat.com',
  sort          = 'keywords_count',
  order         = 'desc',
  return_method = 'df'
)$data

## End(Not run)

Domain competitors in organic search

Description

Returns organic competitors for the domain with their key metrics.

Usage

sst_sa_domain_organic_competitors(
  domain,
  se,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a number of metrics for each organic competitor.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned page.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_organic_competitors(
  domain        = 'serpstat.com',
  se            = 'g_us',
  sort          = list(relevance = 'desc'),
  page          = 2,
  size          = 20,
  return_method = 'df'
)$data

## End(Not run)

Domain top pages

Description

Returns the number of domain pages with the biggest potential traffic, number of keywords, and Facebook shares.

Usage

sst_sa_domain_top_pages(
  domain,
  se,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns domain top pages with their metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned page.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_top_pages(
  domain        = 'serpstat.com',
  se            = 'g_us',
  sort          = list(organic_keywords = 'desc'),
  filters       = list(url_contain = 'blog'),
  page          = 2,
  size          = 50,
  return_method = 'df'
)$data

## End(Not run)

URLs in domain

Description

Returns a list of URLs within the analyzed domain and the number of keywords for each URL.

Usage

sst_sa_domain_urls(
  domain,
  se,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list of URLs with metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned URL.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domain_urls(
  domain        = 'serpstat.com',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Domains summary

Description

Returns the number of keywords for each domain in SEO and PPC, online visibility and other metrics.

Usage

sst_sa_domains_info(
  domains,
  se,
  sort = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns aggregated stats for each domain.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per domain in request.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Examples

## Not run: 
sst_sa_domains_info(
  domains       = c('amazon.com', 'ebay.com'),
  se            = 'g_us',
  return_method = 'df'
)$data

## End(Not run)

Intersection of domains

Description

Returns common keywords for up to 3 domains.

Usage

sst_sa_domains_intersection(
  domains,
  se,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns common keywords for the domains.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned keyword.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domains_intersection(
  domains       = c('amazon.com', 'ebay.com'),
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Rating Data for Domains

Description

Returns market research data for a list of specified domains, including their category classification and SEO metrics.

Usage

sst_sa_domains_rating_data(
  domains,
  se,
  sort = NULL,
  order = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns market research ratings for the domains.

API docs

Check all the values for request and response fields here.

API credits consumption

1 credit per row in response.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domains_rating_data(
  domains       = c('amazon.com', 'ebay.com'),
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

Unique keywords of domains

Description

Returns unique keywords of one or two domains that a third domain does not rank for.

Usage

sst_sa_domains_unique_keywords(
  domains,
  minus_domain,
  se,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns unique keywords for the domains.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per returned keyword.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_domains_unique_keywords(
  domains       = c('amazon.com'),
  minus_domain  = 'ebay.com',
  se            = 'g_us',
  page          = 1,
  size          = 100,
  return_method = 'df'
)$data

## End(Not run)

exportKeywordsPhrase

Description

exportKeywordsPhrase

Usage

sst_sa_keyword_export_keywords_phrase(
  keyword,
  search_engine,
  filters = NULL,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

exportSuggestions

Description

exportSuggestions

Usage

sst_sa_keyword_export_suggestions(
  search_engine,
  keyword,
  filters = NULL,
  with_questions = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getAdKeywords

Description

getAdKeywords

Usage

sst_sa_keyword_get_ad_keywords(
  keyword,
  search_engine,
  domains,
  minus_keywords = NULL,
  filter = NULL,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getAdsCompetitors

Description

getAdsCompetitors

Usage

sst_sa_keyword_get_ads_competitors(
  keyword,
  search_engine,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getCompetitors

Description

getCompetitors

Usage

sst_sa_keyword_get_competitors(
  keyword,
  search_engine,
  filters = NULL,
  sort = NULL,
  order = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getKeywordTop

Description

getKeywordTop

Usage

sst_sa_keyword_get_keyword_top(
  keyword,
  search_engine,
  filters = NULL,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getSuggestions

Description

getSuggestions

Usage

sst_sa_keyword_get_suggestions(
  keyword,
  search_engine,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getTopUrls

Description

getTopUrls

Usage

sst_sa_keyword_get_top_urls(
  keyword,
  search_engine,
  sort = NULL,
  order = NULL,
  page = 1,
  page_size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Top for a keyword

Description

Returns a list of results (URLs) from search engine results page (SERP) including organic results, paid results and different types of SERP features.

Usage

sst_sa_keyword_top(
  keyword,
  se,
  sort = NULL,
  size = 100,
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list with the data about search engine results page for the keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per URL in response.

Examples

## Not run: 
sst_sa_keyword_top(
  keyword   = 'serpstat',
  se        = 'g_us',
  size  = 10
)

## End(Not run)

Keyword trends

Description

Returns monthly search volume trends for a list of keywords over a specified period (up to 48 months). You can send up to 100 keywords per request.

Usage

sst_sa_keyword_trends(
  keywords,
  se,
  months = 48,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns monthly search volume trends for each keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

10 credits per keyword that returned data. If no keywords returned data — 1 credit is charged for the whole request.

Examples

## Not run: 
sst_sa_keyword_trends(
  keywords      = c('seo', 'ppc', 'serpstat'),
  se            = 'g_us',
  months        = 12,
  return_method = 'df'
)$data

## End(Not run)

Phrase match keywords

Description

A full-text search to find all the keywords that match the queried term with a number of metrics for each keyword like search volume, CPC and competition level.

Usage

sst_sa_keywords(
  keyword,
  se,
  minusKeywords = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  with_intents = TRUE,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a number of metrics for each keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per keyword in response.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Filtering

To filter the results you can use filters argument. It must be a list of named elements. The name of the element must match one of the filtering parameters. See API docs for more details. For example, filters = list(queries_from = 0, queries_to = 10) would narrow the results to include only the keywords that have a search volume between 0 and 10.

Examples

## Not run: 
sst_sa_keywords(
  keyword       = 'serpstat',
  se            = 'g_us',
  minusKeywords = c('free'),
  sort          = list(keyword_length = 'asc'),
  page          = 2,
  size          = 10,
  return_method = 'df'
)$data

## End(Not run)

Keywords summary

Description

Returns a number of metrics for each keyword like search volume, CPC and competition level.

Usage

sst_sa_keywords_info(
  keywords,
  se,
  sort = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a number of metrics for each keyword.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per keyword in request.

Sorting

You can sort the response using sort argument. It must be a list with a single named element. The name of the element must match one of parameters in response. The value of the element must be asc for ascending order and desc for descending order. For example, sort = list(ads = 'desc') would sort the response by ads parameter in descending order.

Examples

## Not run: 
sst_sa_keywords_info(
  keywords      = c('seo', 'ppc', 'serpstat'),
  se            = 'g_us',
  sort          = list(cost = 'asc'),
  return_method = 'df'
)$data

## End(Not run)

Market Research Categories

Description

Returns a complete list of available market research categories used for domain classification.

Usage

sst_sa_market_categories(
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns a list of category identifiers and names.

API docs

Check all the values for request and response fields here.

API credits consumption

0 credits.

Examples

## Not run: 
sst_sa_market_categories(return_method = 'df')$data

## End(Not run)

Related keywords for a keyword

Description

Returns a list of semantically related keywords for a given keyword.

Usage

sst_sa_related_keywords(
  keyword,
  se,
  with_intents = FALSE,
  filters = NULL,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns related keywords for a keyword and their metrics.

API docs

Check all the values for request and response fields here.

API credits consumption

1 per keyword in response.

Examples

## Not run: 
sst_sa_related_keywords(
  keyword       = 'serpstat',
  se            = 'g_us',
  return_method = 'df'
)$data

## End(Not run)

Get the number of API rows left

Description

With most API request you spend some amount of API rows. The total amount of API rows available for you is based on your plan. Use this method to control the amount of API rows left.

Usage

sst_sa_stats(api_token = Sys.getenv("SERPSTAT_API_TOKEN"))

Arguments

Value

Returns a number of API rows left. Also returns some additional information about user and Serpstat plugin limits.

API credits consumption

0

Examples

## Not run: 
sst_sa_stats()$summary_info$left_lines

## End(Not run)

getSummaryTraffic

Description

getSummaryTraffic

Usage

sst_sa_url_get_summary_traffic(
  search_engine,
  domain,
  url_contains,
  output_data = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getUrlCompetitors

Description

getUrlCompetitors

Usage

sst_sa_url_get_url_competitors(
  search_engine,
  url,
  sort = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getUrlKeywords

Description

getUrlKeywords

Usage

sst_sa_url_get_url_keywords(
  search_engine,
  url,
  with_intents = NULL,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getUrlMissingKeywords

Description

getUrlMissingKeywords

Usage

sst_sa_url_get_url_missing_keywords(
  url,
  search_engine,
  sort = NULL,
  filters = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addKeywordList

Description

addKeywordList

Usage

sst_sc_add_keyword_list(
  keywords,
  search_engine_id,
  country_id,
  region_id = NULL,
  language_id = NULL,
  type_id = NULL,
  type = NULL,
  pages = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Add crawling task

Description

Submits keywords to crawl regular SERP and local results.

Usage

sst_sc_add_task(
  keywords,
  country_id,
  se_id = 1,
  region_id = NULL,
  language_id = 1,
  device_type_id = 1,
  results_type = "regular_aio",
  pages = 1,
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  return_method = "list"
)

Arguments

Value

Returns the task ID.

API docs

Check all the values for request and response fields here.

API credits consumption

Depends on the number of keywords and pages to parse.

Examples

## Not run: 
sst_sc_add_task(
  keywords = c("explain the gauss rifle principle",
               "why iphone better than samsung"),
  country_id = 23
)

## End(Not run)

getKeywordSerp

Description

getKeywordSerp

Usage

sst_sc_get_keyword_serp(
  task_id,
  keyword_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getList

Description

getList

Usage

sst_sc_get_list(
  page = 1,
  page_size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getParsingBalance

Description

getParsingBalance

Usage

sst_sc_get_parsing_balance(
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

Get crawling task result

Description

Retrieves parsing results of a crawling task.

Usage

sst_sc_get_task_result(
  task_id,
  page = 1,
  api_token = Sys.getenv("SERPSTAT_API_TOKEN"),
  return_method = "list"
)

Arguments

Value

Returns the parsing results for the specified task.

API docs

Check all the values for request and response fields here.

API credits consumption

0

Examples

## Not run: 
sst_sc_get_task_result(
  task_id = 5484945
)

## End(Not run)

activateUser

Description

activateUser

Usage

sst_tm_activate_user(
  user_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addUser

Description

addUser

Usage

sst_tm_add_user(
  email,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

deactivateUser

Description

deactivateUser

Usage

sst_tm_deactivate_user(
  user_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getList

Description

getList

Usage

sst_tm_get_list(
  search = NULL,
  page = 1,
  size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

removeUser

Description

removeUser

Usage

sst_tm_remove_user(
  user_id,
  merge_projects,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

addKeywordListFreq

Description

addKeywordListFreq

Usage

sst_vc_add_keyword_list_freq(
  keywords,
  region_id,
  type_id = NULL,
  search_engine_id = NULL,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getTaskResult

Description

getTaskResult

Usage

sst_vc_get_task_result(
  task_id,
  page = 1,
  page_size = 100,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.

getTaskStatus

Description

getTaskStatus

Usage

sst_vc_get_task_status(
  task_id,
  return_method = "list",
  api_token = Sys.getenv("SERPSTAT_API_TOKEN")
)

Arguments

Value

Returns the API response.

API docs

Check all the values for request and response fields here.