Public: Brands

Get a brand overview

One call that says what state a brand is in: the languages its site serves, 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/

Request

  • Base URL: https://api.iterant.ai
  • URL: https://api.iterant.ai/api/v1/public/brands/{brandSlug}/overview/
  • 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.

sectionsstring

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

window'28d' | '7d' | '90d'

Rolling window ending today.

Response

brandSlugstring required
namestring required
websiteUrlstring required
localesstring[] required

The languages the site serves, the default first. Every page is served in each of them.

nextActionsstring[]

Changes

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