sst_au_get_summary: Website audit summary

View source: R/audit.R

sst_au_get_summaryR Documentation

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, report_id = NULL)

Arguments

api_token

(required) Serpstat API token from your profile.

report_id

(required) ID of the audit report to get data from.

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: 
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_au_get_summary(
  api_token = api_key,
  report_id = report_id
  )$data

## End(Not run)

serpstatr documentation built on Sept. 11, 2024, 7:16 p.m.