---
title: "Get a brand overview"
method: GET
path: "/api/v1/public/brands/{brandSlug}/overview/"
tags: ["Public: Brands"]
---

# Get a brand overview

`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

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.

## Path parameters

- `brandSlug` string, required

## Query parameters

- `responseFormat` 'concise' | 'detailed'
- `sections` string
- `window` '28d' | '7d' | '90d'

## Response `200`

- PublicBrandOverview: One orientation read. Every section is optional: `sections` selects them.
  - `brandSlug` string, required
  - `name` string, required
  - `websiteUrl` string, required
  - `locales` string[], required: The languages the site serves, the default first. Every page is served in each of them.
  - `pages` PublicOverviewPagesSection
    - `total` integer, required
    - `byStatus` object, required
    - `liveSiteUrl` string, nullable, required
    - `recentlyUpdated` PublicOverviewPage[], required
      - `urlPath` string, required
      - `title` string, required
      - `status` string, required
  - `opportunities` PublicOverviewOpportunitiesSection
    - `totalOpen` integer, required
    - `byStatus` object, required
    - `top` object[], required
  - `coverage` PublicOverviewCoverageSection
    - `themesTracked` integer, required
    - `covered` integer, required
    - `gaps` integer, required
    - `topGaps` PublicCoverageGap[], required
      - `theme` string, required
      - `intent` string, required
      - `opportunities` integer, required
  - `visibility` PublicOverviewVisibilitySection
    - `enabled` boolean, required
    - `windowDays` integer, required
    - `visibilityScore` PublicKpi, required
      - `value` number, double, nullable, required
      - `previous` number, double, nullable, required
      - `of` integer, nullable
    - `shareOfVoice` PublicKpi, required
      - `value` number, double, nullable, required
      - `previous` number, double, nullable, required
      - `of` integer, nullable
    - `sovRank` PublicKpi, required
      - `value` number, double, nullable, required
      - `previous` number, double, nullable, required
      - `of` integer, nullable
    - `topCompetitor` string, nullable, required
  - `signals` PublicOverviewSignalsSection
    - `windowDays` integer, required
    - `estimated` boolean, required: Always true: mart figures are sampling-weighted estimates.
    - `sessions` integer, required
    - `conversions` integer, required
    - `aiAssistantReferrals` integer, required
    - `botHits` integer, required
  - `nextActions` string[]

## Other responses

- `400`
- `401`
- `404`
- `405`
- `406`
- `415`
- `429`
- `500`

---

[API](https://skmtc.dev/iterant/apis/iterant-public-api.md) · [All operations](https://skmtc.dev/iterant/apis/iterant-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/iterant/apis/iterant-public-api/revisions/8d62f6ac9cbd?raw)