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

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
/api/v1/public/brands/

Authorization

tenantApiKeyAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?string

1-100, default 25.

offset?string

Rows to skip.

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"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/public/brands/"
{  "items": [    {      "brandSlug": "orbital-labs",      "name": "Orbital Labs",      "websiteUrl": "https://orbital-labs.com",      "status": "ready",      "defaultLanguage": "en",      "publishedPages": 34,      "openOpportunities": 12    }  ],  "total": 1,  "offset": 0,  "limit": 25,  "note": ""}

Last updated on

API reference

Every public REST endpoint, generated from the OpenAPI schema and grouped by the resource it reads.

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.