Sites

Check what works on a site and what is missing before going live

Reads the live files of a site, detects its kind (or takes type) and checks what can be checked automatically: terms, privacy, returns and contact pages with company details; forms that post to a real collection (not nowhere, not only mailto, not localStorage); buy buttons and a cart that lead to a real checkout; prices with currency; no placeholder text; no test wording on a live project; internal links that work; a 404 page; no password checked in JavaScript. It also checks findability: a title (10 to 60 characters) and a meta description (50 to 160) per page, exactly one h1, the page language, a share preview (og:title, og:description and an absolute og:image), alt text on images, images over 500 KB, a viewport meta tag and a favicon; and structured data (JSON-LD): existing blocks are checked for valid JSON, their required fields and leftover placeholders, and when there is none and the kind is known it offers a ready snippet to fill with the user's real details. Returns what works, what is missing (each with a plain explanation and the next tool), and what only the owner can confirm (check_with_owner). Advice only: it never blocks a deploy.

get/sites/{id}/readiness

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/{id}/readiness
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the site.

Query parameters

type'webshop' | 'bookings' | 'restaurant' | 'course_membership' | 'wordpress_portal'

The kind of application; leave it out to detect it from the site.

Response

What works, what is missing, and what to check with the owner.

type'webshop' | 'bookings' | 'restaurant' | 'course_membership' | 'wordpress_portal' | 'null' nullable required
type_source'given' | 'detected' | 'none' required
region'eu' | 'uk' | 'us' | 'other' required
countrystring nullable required
pages_checkedinteger required
notestring required
summary_markdownstring required

Changes

No recorded changes to this operation across all 1 revision of this API.