sst_au_get_summary: Website audit summary

In serpstatr: 'Serpstat' API Wrapper

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

api_token	(required) Serpstat API token from your profile. Default is Sys.getenv('SERPSTAT_API_TOKEN').
report_id	(required) ID of the audit report to get data from.
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 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)

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