website_audit: how ready your site is for AI search
website_audit reads and runs a brand's Website Audit: how ready its site is for AI search and Google, the root causes behind the problems, per-page scores and an action checklist. A brand has at most one audit.
Read it with a view. Run it with an action: start the audit, refresh changed pages, re-run everything, re-check a page you just fixed, or tick off an action.
What it can read and do
Every call names a brand and either a view (what to read) or, on the two audit tools, an action (what to change). With neither, the tool returns its default view.
auditDefault- The summary, the checks and per-page scores.
problems- Root causes, biggest impact first.
pages- Pages, weakest first. Filter by urgency, max_score or url_contains, and add pages no longer on the site with include_removed.
actions- The action checklist, reconciled with the latest results the way the dashboard does it. Filter by status or priority.
progress- Whether a run is running, done or failed.
startOwn cost- Audit the brand's site; website_url defaults to the brand's website. A brand has one audit. Costs 1 credit, as in the dashboard.
refresh- Re-check only new or changed pages.
rerun- Re-check every page from scratch.
recheck_page- Re-check one page_url. A page that isn't in the audit yet is added.
update_action_status- Mark the action titled item as done, dismissed or in progress, or reopen it. Pass page_url when two actions share a title.
What a call costs
- Reads, with any view, cost 1 credit per call.
- start skips that fee and costs 1 credit, the same as starting an audit in the dashboard.
- refresh, rerun, recheck_page and update_action_status cost the 1-credit call fee and nothing more.
Input parameters
Every parameter the tool's input schema accepts. Your assistant fills these in from what you ask; you never type them yourself.
| Parameter | What it does |
|---|---|
brandRequired | The brand's name, case-insensitive, as brand_insights lists it. |
view | What to read: audit (default), problems, pages, actions or progress. |
action | What to do: start, refresh, rerun, recheck_page or update_action_status. Leave it out to read. |
status | view actions: only this status. update_action_status: the new status (done, dismissed, in_progress or reopen). |
priority | view actions: high, medium or low. |
urgency | view pages: only this urgency, high, medium or low. |
max_score | view pages: only pages scoring at or below this, from 0 to 100. |
url_contains | view pages: only URLs containing this text. |
include_removed | view pages: include pages that are no longer on the site. |
limit | view problems, pages or actions: rows to return. |
item | update_action_status: the action's title. |
website_url | start: the site to audit. Defaults to the brand's website. |
name | start: the audit's name. Defaults to the brand name. |
description | start: a short description of the brand or site. |
page_url | recheck_page: the full URL or the path on the audited site. update_action_status: the action's page, to tell same-titled actions apart. |
Questions that use this tool
Ask in plain language and the assistant picks the view or action. These make good first questions.
- “What's the biggest problem on [brand]'s website right now?”
- “Which pages score below 50, and why?”
- “I fixed the pricing page. Re-check it and tell me what changed.”
- “Refresh [brand]'s audit, then list the open high-priority actions.”
- “Mark the action about FAQ schema on /pricing as done.”
Questions about this tool
How do I know when a run has finished?
Call view progress. It reports running, done or failed.
What's the difference between refresh and rerun?
refresh checks only new or changed pages. rerun checks every page again from scratch.
Can it check a page that isn't in the audit?
Yes. recheck_page adds a page_url the audit doesn't have yet, then checks it.