serpstatr (version 0.4.0)

sst_au_get_summary: 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
)

Value

Returns the basic metrics for audited website.

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.

API docs

Check all the values for request and response fields here.

API credits consumption

0.

Examples

if (FALSE) {
sst_au_get_summary(
  report_id = report_id
  )$data
}