sst_au_start {serpstatr} | R Documentation |
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, project_id = NULL)
Arguments
api_token |
(required) Serpstat API token from your profile. |
project_id |
(required) ID of the project in Serpstat. |
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:
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_au_start(
api_token = api_token,
project_id = 12345
)$data$reportId
## End(Not run)
[Package serpstatr version 0.3.0 Index]