Menu

Referência da API · Auditoria Web

Execuções

seo_site_auditor · runs · 6 operações

GET/v1/seo/site-auditor/runs

List the site audits

seo_site_auditor.runs.list

LeituraIdempotenteDesde 2026-11-01

Lists the organization's site audits, newest first, paginated by cursor (limit up to 200); site_id narrows it to one site. Each audit has its status (pending: queued; crawling; analyzing; completed; completed_with_errors: finished but some pages could not be read; failed: error says why), how it started (triggered_by manual or schedule), its timestamps and, once finished, health_score (0–100) with the share of pages it could read (coverage, low_coverage), geo_readiness_score, total_pages, total_issues, issues_by_severity, crawl_stats and crawl_method. status filters on the page read, so a page can bring fewer than limit while has_more is true: follow next_cursor. A site keeps its last 52 audits. Requires view access to Site Audit.

Escopo
seo_site_auditor:read
Permissão
Ver o módulo
Tool do MCP
seo_site_auditor_runs_listNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.list".

Custo declarado: até 201 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

site_idstringqueryopcional

Only the audits of this site.

statusenumqueryopcional

Only audits in this status (applied on the page read: a page can bring fewer than limit).

Valores: pending, crawling, analyzing, completed, completed_with_errors, failed

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

curl "https://api.mb-suite.com/v1/seo/site-auditor/runs" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/seo/site-auditor/runs" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/seo/site-auditor/runs/{run_id}

Get one site audit with its scores

seo_site_auditor.runs.get

LeituraIdempotenteDesde 2026-11-01

Returns one site audit: status, timestamps, health_score with the score of each category (category_scores: crawling, meta_tags, content, links, images, speed, security, sitemaps, redirects, usability, resources, localization, structured_data, open_graph), issues_by_severity, the PageSpeed Insights results of the sampled pages (psi_results: Lighthouse scores and Core Web Vitals, rounded; include_psi_details: true adds the opportunities, diagnostics and agentic-browsing checks, tens of thousands of characters in a large audit), the GEO readiness checks (geo_checks: what AI search engines need), site-level checks the site blocked (site_level_blocks), crawl_stats with coverage and low_coverage (health_score is computed only over the pages that could be read: under 20% read, it says little about the site) and error. The issues are in seo_site_auditor.issues.list and the pages in seo_site_auditor.pages.list. Not found (audit_run_not_found) if the audit does not exist. Requires view access to Site Audit.

Escopo
seo_site_auditor:read
Permissão
Ver o módulo
Tool do MCP
seo_site_auditor_runs_getNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.get".

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

run_idstringrotaobrigatório

Audit id (id from seo_site_auditor.runs.list, or run_id from seo_site_auditor.runs.trigger).

include_psi_detailsbooleanqueryopcional

true adds the Lighthouse opportunities, diagnostics and agentic-browsing checks of each PageSpeed result (tens of thousands of characters in a large audit). Default false: scores and Core Web Vitals only.

Padrão: false

Resposta

idstring
site_idstring
urlstring
statusenum

Valores: pending, crawling, analyzing, completed, completed_with_errors, failed

triggered_byenum

Valores: manual, schedule

triggered_by_user_idstring | null
health_scorenumber | null
geo_readiness_scorenumber | null
total_pagesnumber | null
total_issuesnumber | null
issues_by_severityobject | null
crawl_methodstring | null
crawl_statsobject | null
coveragenumber | null

Share of the pages the crawler could read: successful / (successful + failed), 0 to 1; null before it finished crawling.

low_coverageboolean

true when less than 20% of the pages could be read: health_score is computed only over what was read, so it says little about the site.

excluded_by_pattern_countnumber | null
errorstring | null
created_atnumber
started_atnumber | null
analyzing_atnumber | null
completed_atnumber | null
durationnumber | null

How long it took (ms).

category_scoresobject | null

Score of each category (crawling, meta_tags, content…): the keys are the category ids.

psi_resultsarray<object>

PageSpeed Insights of the sampled pages, mobile and desktop.

site_level_blocksarray<object>
ignored_issues_countnumber
geo_checksarray<object>

Erros

Exemplo

curl "https://api.mb-suite.com/v1/seo/site-auditor/runs/{run_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/seo/site-auditor/runs/{run_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/seo/site-auditor/sites/{site_id}/runs

Start an audit of a site now

seo_site_auditor.runs.trigger

EscritaDesde 2026-11-01

Starts an audit of a site now: MB Suite's auditor crawls up to the site's max_pages pages, runs PageSpeed Insights on a sample and checks SEO, speed, security and GEO readiness (each issue in the language of the person who starts it). Returns the new run_id right away; the audit runs in the background, usually 5 to 30 minutes depending on the site. dispatched=false means the service did not answer in time: the audit stays queued and the service can still take it (if not, it is marked failed within 15 minutes). When it finishes, the site's notify_emails get the results by email. Fails without starting anything when another audit of the site is queued or running (audit_in_progress, 409, with its run_id), in demo organizations (demo_read_only, 403), from an API key or app after 5 audits of the site started that way in 24 hours (daily_limit_reached, 429, resource site_audits, with retry_after; scheduled audits are not affected), and while the audit service is not available (audit_service_unavailable, 503 with retry_after); when the service rejects it (audit_dispatch_failed, 500) the audit is left as failed. Not idempotent: each call that succeeds starts an audit. Requires edit access to Site Audit.

Instruções para agentes

The audit runs in the background: call seo_site_auditor.runs.get with this run_id every minute or two until status is completed, completed_with_errors or failed, then read seo_site_auditor.issues.list.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
seo_site_auditor:write
Permissão
Editar no módulo
Tool do MCP
seo_site_auditor_runs_triggerNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.trigger".

Custo declarado: até 55 leituras e 2 escritas por chamada (contam na cota diária). Usa uma plataforma externa (cloud_run): conta na cota de operações externas.

Parâmetros

site_idstringrotaobrigatório

Audited site id (id from seo_site_auditor.sites.list).

Resposta

run_idstring
status"pending"
dispatchedboolean

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo/site-auditor/sites/{site_id}/runs" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

DELETE/v1/seo/site-auditor/runs/{run_id}

Delete one site audit

seo_site_auditor.runs.delete

IrreversívelDesde 2026-11-01

Deletes one finished audit for good, with its issues and its crawled pages. It does NOT go to the trash and cannot be undone; the site and its other audits are kept (if it was the site's latest, the site then shows the previous finished one). An audit still queued or running cannot be deleted (audit_in_progress, 409). Outside the screen it requires a dry run (which counts what will be deleted) and a confirm_token. Not found (audit_run_not_found) if the audit does not exist. Requires edit access to Site Audit and, for a credential, deletion enabled.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
seo_site_auditor:write e «Permitir exclusões» (seo_site_auditor:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
seo_site_auditor_runs_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.delete".

Custo declarado: até 25 leituras e 30 escritas por chamada (contam na cota diária).

Parâmetros

run_idstringrotaobrigatório

Audit id (id from seo_site_auditor.runs.list, or run_id from seo_site_auditor.runs.trigger).

Resposta

oktrue

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/seo/site-auditor/runs/{run_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/seo/site-auditor/runs/{run_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dry_run": true
}'
POST/v1/seo/site-auditor/runs/bulk/delete

Delete several site audits

seo_site_auditor.runs.bulk.delete

IrreversívelEm massa · até 200Desde 2026-11-01

Deletes up to 200 finished audits for good, each with its issues and crawled pages (repeated ids count once). They do NOT go to the trash and it cannot be undone. Ids that do not exist come back in not_found and audits still queued or running are skipped and come back in in_progress: neither fails the batch. Outside the screen it always needs a dry run (the preview counts what will be deleted and lists what will be skipped) and its confirm_token. Returns deleted, deleted_run_ids, not_found and in_progress. Requires edit access to Site Audit and, for a credential, deletion enabled.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
seo_site_auditor:write e «Permitir exclusões» (seo_site_auditor:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
seo_site_auditor_runs_bulk_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.bulk.delete".

Custo declarado: até 450 leituras e 1000 escritas por chamada (contam na cota diária).

Parâmetros

run_idsarray<string>corpoobrigatório

Audits to delete (up to 200; repeated ids count once).

Resposta

deletednumber
deleted_run_idsarray<string>
not_foundarray<string>
in_progressarray<string>

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo/site-auditor/runs/bulk/delete" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "run_ids": [
    "RUN_ID"
  ],
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/seo/site-auditor/runs/bulk/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "run_ids": [
    "RUN_ID"
  ],
  "dry_run": true
}'
POST/v1/seo/site-auditor/runs/{run_id}/export-pdf

Export a site audit to PDF

seo_site_auditor.runs.export_pdf

LeituraDesde 2026-11-01

Renders a finished audit to an A4 PDF and returns a signed download link that expires in 24 hours, plus the file name and size. variant=full (default) has every section with the page list; variant=commercial is the summary for a client meeting. lang picks the document language (es, en, pt-BR; default the caller's). Rendering can take tens of seconds: while the PDF service is not available it answers pdf_unavailable (503 with retry_after: retry then); an audit too heavy to render in time answers pdf_render_timeout (409: the same request will time out again, try variant=commercial, the summary without the page list). An audit that failed or is still running has nothing to export (audit_not_completed, 409). Not idempotent: each call renders a new file. It changes nothing in MB Suite, so a read-only credential can run it (it is a read with the cost of rendering). Requires view access to Site Audit; not available in the public demo (403 demo_read_only).

Instruções para agentes

Give the person the download link and say it expires in 24 hours. Do not paste the link anywhere public.

Escopo
seo_site_auditor:read
Permissão
Ver o módulo
Tool do MCP
seo_site_auditor_runs_export_pdfNa superfície completa; na compacta, mb_execute_operation com id: "seo_site_auditor.runs.export_pdf".

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária). Usa uma plataforma externa (pdf): conta na cota de operações externas.

Parâmetros

run_idstringrotaobrigatório

Audit id (id from seo_site_auditor.runs.list, or run_id from seo_site_auditor.runs.trigger).

variantenumcorpoopcional

full (default: every section, with the page list) or commercial (the summary for a client meeting).

Valores: commercial, full · Padrão: "full"

langenumcorpoopcional

Language of the document (default: the caller's).

Valores: es, en, pt-BR

Resposta

download_urlstring
file_namestring
size_bytesnumber
expires_atnumber

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo/site-auditor/runs/{run_id}/export-pdf" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.