Skip to main content
The Readiness Score API inspects a domain across five capability areas — discoverability, catalog, checkout, schema, and attribution — and returns a single score and a prioritised list of gaps to fix. Use it to assess a domain before implementation begins, to validate after each implementation step, or to run batch audits across multiple client domains. All calls require authentication — see Authentication.

Endpoint


Request parameters

string
required
The domain to audit, without https://. Example: "yourstore.com"
string[]
Specific checks to run. Omit this field to run all checks.Available values: well_known, catalog, checkout, schema, feed, attribution, entity
boolean
When true, the API returns a cached result without re-fetching the domain. Use this during development to test your integration without triggering a live audit.
What each check tests: Example request:

Response fields

string
The domain that was audited.
integer
Overall readiness score from 0 to 100. Higher is better.
string
Letter grade based on the score.
string
ISO 8601 timestamp of when the audit ran.
array
Issues found, ordered by severity. Each item in the array contains:
string
Unique identifier for this gap type, for example well_known_missing.
string
Which check category this gap belongs to.
string
How urgently this gap needs fixing: critical, high, medium, or low.
string
Short human-readable description of the gap.
string
Full explanation of the gap and its impact on AI commerce.
string
Link to the relevant Asva tool to fix this gap. May be null if no tool applies.
object
Score breakdown by category. Each field is an integer from 0 to 100.
integer
Score for agent discoverability — manifest presence and validity.
integer
Score for product catalog quality and structure.
integer
Score for checkout endpoint availability and correctness.
integer
Score for attribution snippet presence and configuration.
string[]
List of check IDs that passed with no issues.

Severity reference


Example request and response

Example response:

Batch auditing

For agencies auditing multiple domains, loop through the API:
The /api/audit endpoint allows 60 requests per hour. Space out batch jobs or use dry_run: true for subsequent calls against the same domain within the same session.