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

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.

GET
/api/v1/public/brands/{brandSlug}/overview/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

brandSlug*string
Match^[^/]+$

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"
sections?string

Comma-separated. Legal values: pages, opportunities, coverage, visibility, signals. Defaults to all five.

window?string

Rolling window ending today.

Default"28d"

Value in

  • "28d"
  • "7d"
  • "90d"

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/overview/"
{  "brandSlug": "orbital-labs",  "name": "Orbital Labs",  "websiteUrl": "https://orbital-labs.com",  "opportunities": {    "totalOpen": 12,    "byStatus": {      "ready": 9,      "drafted": 3    },    "top": []  },  "visibility": {    "enabled": false,    "windowDays": 28,    "visibilityScore": {      "value": null,      "previous": null    },    "shareOfVoice": {      "value": null,      "previous": null    },    "sovRank": {      "value": null,      "previous": null,      "of": 0    },    "topCompetitor": null  },  "nextActions": [    "12 open page opportunities: read the queue with the page-opportunities list, highest priority first."  ]}

Last updated on

List accessible brands

The brands this credential can read, with their slug, site and how much work is outstanding on each. Call this first when the brand is not already known: every other route takes a `brandSlug`. An org-scoped key returns every brand in the organization; a brand-pinned key returns exactly its own.

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.