Planned

Website Intelligence API

This family is intentionally scaffolded as a draft example. It proves the route, docs, and dashboard shape for a future product without claiming that the product is already live.

Current status

Draft example placeholder used to validate the product-family contract. No live customer-facing capability is implied yet.

Namespace/v1/web
Endpoint count5 documented routes

Planned capabilities

The scope below is descriptive only. No route should be treated as live until the status changes.

  • Metadata extraction
  • robots.txt inspection
  • Sitemap discovery
  • Structured data parsing
  • Page-level audit workflows

Endpoint reference

The routes below are documented from the shared platform registry and reflect the current implemented contract for this family. Some routes may be environment-dependent, such as billing when no adapter is configured.

Inspect page metadata.

Placeholder endpoint for retrieving normalized metadata from a target URL.

GET /v1/web/metadata
Handler statusPlaceholder

Inspect robots.txt directives.

Placeholder endpoint for retrieving and parsing robots.txt policy data.

GET /v1/web/robots
Handler statusPlaceholder

Discover sitemap resources.

Placeholder endpoint for sitemap index and sitemap discovery workflows.

GET /v1/web/sitemaps
Handler statusPlaceholder

Extract structured data blocks.

Placeholder endpoint for JSON-LD and related structured data extraction.

GET /v1/web/structured-data
Handler statusPlaceholder

Run a website audit.

Placeholder endpoint for broader site audit or page audit analysis.

GET /v1/web/audit
Handler statusPlaceholder

Activation path

When implementation moves beyond placeholders, keep the namespace, docs page, and dashboard label aligned. Replace placeholder handlers in the corresponding API module rather than redesigning the platform surface.