Public: Pages

Get one page by route

Full detail for one page: meta, status and publish time.

urlPath takes any route the site serves the page at, including a localized one: /es/pricing (or /es/feed/pricing for a brand on a folder) returns the /pricing page with requestedLocale set to es. locales lists every language and its route.

responseFormat=detailed adds outline, the page's section components in order.

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

Request

  • Base URL: https://api.iterant.ai
  • URL: https://api.iterant.ai/api/v1/public/brands/{brandSlug}/pages/by-path/
  • Auth: HTTP bearer

Path parameters

brandSlugstring required

Query parameters

responseFormat'concise' | 'detailed'

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.

urlPathstring

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

Response

urlPathstring required
titlestring required
statusstring required
updatedAtstring date-time required
liveUrlstring nullable required
requestedLocalestring required

The language the requested urlPath serves: the default for the page's own route, or the language a page written in one language alone declares.

metaTitlestring required
metaDescriptionstring required
publishedAtstring date-time nullable required
triggeringOpportunityRefstring nullable required
outlinestring[] required

The page's section components, in order. Present only when responseFormat=detailed.

Changes

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