Iterant is in early access. These docs describe the product as it works today.
Iterant Docs
pages

Get one page by route

Full detail for one page: meta, indexability, draft vs published version, approval state and the translation group. `approvalState` is one of `unsupported`, `no_approval`, `no_diff`, `has_diff`. `has_diff` means the draft has moved since a reviewer approved it, and `unsupported` means the page never entered the approval workflow. A translation entry with a `staleReason` means the source copy moved after Iterant produced that locale. `responseFormat=detailed` adds `outline`, the page's section components in order.

GET
/api/v1/public/brands/{brandSlug}/pages/by-path/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

brandSlug*string

Query Parameters

locale?string

Disambiguate when a route exists in several locales. Takes the locale value this API returns for a page.

Value in

  • "en"
  • "pt-BR"
  • "pt-PT"
responseFormat?string

How much to return. concise (the default) omits long-form text: briefs, outlines, evidence, passage excerpts, per-dimension breakdowns. detailed includes it and costs several times the tokens.

Default"concise"

Value in

  • "concise"
  • "detailed"
urlPath?string

Page route as returned by the pages list, e.g. "/pricing". Always starts with "/".

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/public/brands/string/pages/by-path/"
{  "urlPath": "/pricing",  "title": "Pricing",  "status": "published",  "locale": "en",  "approvalState": "has_diff",  "translationGroup": {    "locales": [      {        "locale": "pt-PT",        "urlPath": "/pt/precos",        "status": "published",        "staleReason": "source_copy_changed"      }    ]  },  "triggeringOpportunityRef": null}

Last updated on

List a brand's pages

Pages with their route, title, status, locale and preview/live URLs. This is where a `urlPath` comes from: every other page route takes one. Capped and paginated. When the cap bites the response carries a `note` saying how to narrow: filter by `status`, `locale` or `urlPathPrefix` rather than paging through everything.

Get a page (or brand-wide) report

How a page is performing, projected to the `metrics` you ask for. Each one is a separate upstream read, so ask for what you need: - `score`: quality and citability grades plus the ranked priority fixes - `performance`: Search Console clicks/impressions/CTR/position and AI-assistant referral clicks by provider - `traffic`: visitor sessions and conversions from the signals mart - `conversions`: per-definition conversion counts - `anatomy`: which components get clicked and how far visitors scroll Every performance block carries a `state`: only `ok` means the numbers are real. `no_data`, `unconfigured` and `error` return null metrics. Report the state, never substitute zero. `traffic`, `conversions` and `anatomy` are sampling-weighted estimates and honour `window`. `performance` is snapshot-shaped: it reports the window the capture covered, which `window` does not change. Omit `urlPath` for a brand-wide roll-up.