sst_au_start: Start a website audit

In serpstatr: 'Serpstat' API Wrapper

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

api_token	(required) Serpstat API token from your profile. Default is Sys.getenv('SERPSTAT_API_TOKEN').
project_id	(required) ID of the project in Serpstat.
return_method	(optional) Accepted values are 'list' (default) to return data object as list or 'df' to return data object as data.frame.

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)

serpstatr documentation built on June 10, 2026, 1:06 a.m.