Skip to main content
The Website API works on the agent’s own Lofty website. It has four parts: a read-only site audit, the traffic report shown in the CRM, Feature Areas (AI-generated community pages) and page SEO.

Who can call it

Only two kinds of callers can use these endpoints:
  • Website-only (Lofty Front) agents
  • Sites on the Hyperlocal Website package
Every other caller gets HTTP 403 with code 403001. A caller with no primary website gets 404001. Every endpoint works on the caller’s primary website. The analytics endpoints also accept a siteId, for agents with more than one site. The site must belong to the caller, or the call fails with 403002.

How the parts fit together

A typical flow:
  1. Find problems with the audit.
  2. Use analytics to see how much traffic the affected pages get.
  3. Fix the pages with page SEO, or add Feature Areas.
  4. Check the result in analytics later.

Site audit

The audit reports facts and doesn’t score them. Drawing conclusions is up to you. Every section returns the same wrapper:
partial is true when part of the section could not be fetched, such as a technical file or a page whose live fetch failed. The affected item carries fetchError with the reason.
On a page item, null means “not checked this time”, not “none”. If the live page could not be fetched, h1, h1Count, hasSchema and schemaTypes are null. Only 0, false or [] mean the live page really has none.
A fetchError starting with redirected to another domain means the page’s URL redirects off the site. Treat that as a problem in itself, and don’t read the other site’s content as this site’s. Audit pages lists only the site’s menu pages, the same pages as the CMS SEO → Page SEO table, up to 100. Feature Area pages, landing pages and blog posts aren’t listed. Audit structure has the site-wide page counts.

Raw templates and rendered values

SEO fields can contain template variables such as {{Company Name}} or {{Brand Name}}. An audit page item carries both versions: A variable that is still in braces in title or description is one the audit could not fill. The live page may show the same text or a fallback value.
Update page SEO takes raw templates. Start from rawTitle / rawDescription / rawKeywords, and keep every variable exactly as it is. If you write back the rendered text, the variable is replaced by fixed text for good.
To change a value that comes from a variable, change its source instead, for example the company name in the CRM.

Page SEO

PUT /v2.0/website/pages/seo changes 1–10 pages per call. Each page is listed once by its pageId, the pageId of an item from Audit pages.
  • Send only the fields you want to change. An empty string clears a field.
  • Limits: title up to 255 characters, description up to 1000, keywords up to 500 (comma separated).
  • Values must not contain <, > or ".
Each page gets its own result, and pages are not rolled back together:

Feature Areas

A Feature Area is a neighborhood or city community page that Lofty writes with AI. Each one has three sub-pages: intro, listing search and market. When you create a Feature Area, Lofty generates the intro (this takes several seconds) and publishes the three pages. Detail and FAQ content and the cover picture are generated afterwards in the background. city and type are always required. displayName replaces the neighborhood name on the website.
Creating a Feature Area publishes pages on a public website. The call fails with 422001 when the same area already exists or the site has reached its Feature Area limit. The message says which.

Traffic analytics

All eight charts take the same optional query parameters: The period is at most 365 days. Website traffic overview returns the change rate against the previous period. The previous value itself isn’t available yet and is null.

Errors

Website API Reference

Full endpoint documentation with parameters and responses.

search_site_audit

The same audit through the Lofty MCP server.