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

Get internal-linking recommendations

Internal links worth adding *to* a page: which existing pages should link to it, the suggested anchor text, and the passage the link would sit in. `relevance` is 0-1; below about 0.6 a placement is usually not worth making. An empty `links` array is a real answer: nothing on the site is a good enough source yet. These are advisory. This endpoint never edits a page, and Iterant does not place these links itself: the source pages are the customer's own, hand-built ones. `responseFormat=detailed` adds the anchor variants and the passage excerpt.

GET
/api/v1/public/brands/{brandSlug}/linking/advisory/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

brandSlug*string

Query Parameters

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/linking/advisory/"
{  "brandSlug": "orbital-labs",  "urlPath": "/compare/orbital-vs-datadog",  "stale": false,  "links": [    {      "sourceUrl": "https://orbital-labs.com/docs/tracing",      "anchorText": "compare Orbital and Datadog",      "relevance": 0.81    }  ],  "note": ""}

Last updated on

Get a brand overview

One call that says what state a brand is in: page counts by status, the highest-priority open opportunities, topic-coverage gaps, the AI-visibility headline and traffic/conversion rollups. Cheaper and better oriented than fanning out across the other routes, and its `nextActions` field points at what is worth looking at next. Narrow with `sections` when you need only half the picture. Signals figures are sampling-weighted estimates, not exact counts. Visibility figures are empty, not zero, when the brand has no tracking enabled.

List page opportunities

Pages Iterant thinks are worth building or improving, ranked by priority score. Each row carries a `ref`: a stable, human-readable handle derived from the title. It is what the detail route takes. Refs are not constructible: use one that came back from here. `status` is the derived display status, which folds in the state of any page the opportunity produced: `ready`/`enriched`/`discovered` are open work, `drafting`/`drafted`/`publishing` are in flight, `published`/`dismissed`/`superseded` are done. Capped and paginated; the `note` says how to narrow when rows are hidden. Filtering by `status` walks rows, so it stops after the 500 highest-priority opportunities; past that bound `total` is null rather than a count of what happened to fit inside it.