SEO

Start Seo Audit

SPENDS CREDITS. Start a site audit of up to max_pages pages.

Credits are RESERVED up front, sized by max_pages, and charged as the crawl completes - credits_charged on the audit says what was. 402 when the balance cannot cover the reservation, 409 when an audit of this domain is already running, 503 when the credit service cannot take the hold.

The audit runs in the background; poll GET /seo/audits/{audit_id} and read state, which explains where it is in plain language and whether it can be run again.

post/seo/audits

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/seo/audits
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

domainstring required
max_pagesinteger
allow_subdomainsboolean
enable_javascriptboolean

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.