Iterant Public: Brands API

The Public: Brands API from Iterant — 2 operation(s) for public: brands.

GitHub OpenAPI

Operations 2

GET /api/v1/public/brands/ List accessible brands #
GET /api/v1/public/brands/{brandSlug}/overview/ Get a brand overview #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/iterant-ai:iterant-ai-public-brands-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

iterant-ai-public-brands-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: 'Iterant Public Public: Brands API'
  version: 1.0.0
  description: 'The Iterant public API: read a brand''s pages, page opportunities, reports and AI visibility, and start Iterant''s agent on a page. Guides: https://iterant.ai/docs/developers/rest-api


    **Authentication.** Send `Authorization: Bearer itr_...`, an API key an organization admin mints at Settings > Developers.


    **Rate limits.** 600 requests per minute per key, and 30 task starts per minute. Responses carry the IETF `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `RateLimit-Policy` fields. A `429` carries `Retry-After` in seconds. Requests without a valid key are limited to 60 per minute per client IP.


    **Idempotency.** `POST .../tasks/` takes an `Idempotency-Key` header. For 24 hours, a retry with the same key and body returns the first task instead of starting a second.


    **Versioning and deprecation.** The version is in the path: `/api/v1/`. Breaking changes ship under a new version. A deprecated version keeps working for at least 6 months after the announcement, and its responses carry `Deprecation` and `Sunset` headers (RFC 9745, RFC 8594). Nothing is deprecated today. Policy: https://iterant.ai/docs/developers/rest-api#versioning-and-deprecation'
servers:
- url: https://api.iterant.ai
  description: Production server
tags:
- name: 'Public: Brands'
paths:
  /api/v1/public/brands/:
    get:
      operationId: publicBrandsList
      description: '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.'
      summary: List accessible brands
      parameters:
      - in: query
        name: limit
        schema:
          type: string
        description: 1-100, default 25.
      - in: query
        name: offset
        schema:
          type: string
        description: Rows to skip.
      - in: query
        name: responseFormat
        schema:
          type: string
          enum:
          - concise
          - detailed
          default: concise
        description: '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.'
      tags:
      - 'Public: Brands'
      security:
      - tenantApiKeyAuth: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicBrandsListErrorResponse400'
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401'
              examples:
                AuthenticationFailed:
                  value:
                    type: client_error
                    errors:
                    - code: authentication_failed
                      detail: Incorrect authentication credentials.
                      attr: null
                NotAuthenticated:
                  value:
                    type: client_error
                    errors:
                    - code: not_authenticated
                      detail: Authentication credentials were not provided.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse405'
              examples:
                MethodNotAllowed:
                  value:
                    type: client_error
                    errors:
                    - code: method_not_allowed
                      detail: Method "get" not allowed.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse406'
              examples:
                NotAcceptable:
                  value:
                    type: client_error
                    errors:
                    - code: not_acceptable
                      detail: Could not satisfy the request Accept header.
                      attr: null
          description: ''
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse415'
              examples:
                UnsupportedMediaType:
                  value:
                    type: client_error
                    errors:
                    - code: unsupported_media_type
                      detail: Unsupported media type "application/json" in request.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse429'
              examples:
                Throttled:
                  value:
                    type: client_error
                    errors:
                    - code: throttled
                      detail: Request was throttled.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse500'
              examples:
                APIException:
                  value:
                    type: server_error
                    errors:
                    - code: error
                      detail: A server error occurred.
                      attr: null
          description: ''
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicBrandList'
              examples:
                OneBrandInTheOrganization:
                  value:
                    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: ''
                  summary: One brand in the organization
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
  /api/v1/public/brands/{brandSlug}/overview/:
    get:
      operationId: publicBrandOverview
      description: '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.'
      summary: Get a brand overview
      parameters:
      - in: path
        name: brandSlug
        schema:
          type: string
          pattern: ^[^/]+$
        required: true
      - in: query
        name: responseFormat
        schema:
          type: string
          enum:
          - concise
          - detailed
          default: concise
        description: '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.'
      - in: query
        name: sections
        schema:
          type: string
        description: 'Comma-separated. Legal values: pages, opportunities, coverage, visibility, signals. Defaults to all five.'
      - in: query
        name: window
        schema:
          type: string
          enum:
          - 28d
          - 7d
          - 90d
          default: 28d
        description: Rolling window ending today.
      tags:
      - 'Public: Brands'
      security:
      - tenantApiKeyAuth: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicBrandOverviewErrorResponse400'
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401'
              examples:
                AuthenticationFailed:
                  value:
                    type: client_error
                    errors:
                    - code: authentication_failed
                      detail: Incorrect authentication credentials.
                      attr: null
                NotAuthenticated:
                  value:
                    type: client_error
                    errors:
                    - code: not_authenticated
                      detail: Authentication credentials were not provided.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse404'
              examples:
                NotFound:
                  value:
                    type: client_error
                    errors:
                    - code: not_found
                      detail: Not found.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse405'
              examples:
                MethodNotAllowed:
                  value:
                    type: client_error
                    errors:
                    - code: method_not_allowed
                      detail: Method "get" not allowed.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse406'
              examples:
                NotAcceptable:
                  value:
                    type: client_error
                    errors:
                    - code: not_acceptable
                      detail: Could not satisfy the request Accept header.
                      attr: null
          description: ''
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse415'
              examples:
                UnsupportedMediaType:
                  value:
                    type: client_error
                    errors:
                    - code: unsupported_media_type
                      detail: Unsupported media type "application/json" in request.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse429'
              examples:
                Throttled:
                  value:
                    type: client_error
                    errors:
                    - code: throttled
                      detail: Request was throttled.
                      attr: null
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse500'
              examples:
                APIException:
                  value:
                    type: server_error
                    errors:
                    - code: error
                      detail: A server error occurred.
                      attr: null
          description: ''
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicBrandOverview'
              examples:
                OpportunitiesAndVisibilityOnly:
                  value:
                    brandSlug: orbital-labs
                    name: Orbital Labs
                    websiteUrl: https://orbital-labs.com
                    locales:
                    - en
                    - es
                    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.'
                  summary: Opportunities and visibility only
          description: ''
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
components:
  schemas:
    ParseErrorCodeEnum:
      enum:
      - parse_error
      type: string
      description: '* `parse_error` - Parse Error'
    PublicOverviewVisibilitySection:
      type: object
      properties:
        enabled:
          type: boolean
        windowDays:
          type: integer
        visibilityScore:
          $ref: '#/components/schemas/PublicKpi'
        shareOfVoice:
          $ref: '#/components/schemas/PublicKpi'
        sovRank:
          $ref: '#/components/schemas/PublicKpi'
        topCompetitor:
          type:
          - string
          - 'null'
      required:
      - enabled
      - shareOfVoice
      - sovRank
      - topCompetitor
      - visibilityScore
      - windowDays
    ErrorCode404Enum:
      enum:
      - not_found
      type: string
      description: '* `not_found` - Not Found'
    Error405:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode405Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    PublicBrandSummary:
      type: object
      properties:
        brandSlug:
          type: string
        name:
          type: string
        websiteUrl:
          type: string
        status:
          type: string
        defaultLanguage:
          type: string
        publishedPages:
          type: integer
        openOpportunities:
          type: integer
      required:
      - brandSlug
      - name
      - openOpportunities
      - publishedPages
      - websiteUrl
    Error406:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode406Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    ParseError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ParseErrorCodeEnum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    PublicCoverageGap:
      type: object
      properties:
        theme:
          type: string
        intent:
          type: string
        opportunities:
          type: integer
      required:
      - intent
      - opportunities
      - theme
    PublicBrandOverviewErrorResponse400:
      oneOf:
      - $ref: '#/components/schemas/ParseErrorResponse'
      discriminator:
        propertyName: type
        mapping:
          client_error: '#/components/schemas/ParseErrorResponse'
    ErrorCode415Enum:
      enum:
      - unsupported_media_type
      type: string
      description: '* `unsupported_media_type` - Unsupported Media Type'
    ParseErrorResponse:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ParseError'
      required:
      - errors
      - type
    ErrorResponse405:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error405'
      required:
      - errors
      - type
    Error500:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode500Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    ErrorResponse404:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error404'
      required:
      - errors
      - type
    Error415:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode415Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    ServerErrorEnum:
      enum:
      - server_error
      type: string
      description: '* `server_error` - Server Error'
    ErrorResponse429:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error429'
      required:
      - errors
      - type
    ErrorCode406Enum:
      enum:
      - not_acceptable
      type: string
      description: '* `not_acceptable` - Not Acceptable'
    ErrorCode405Enum:
      enum:
      - method_not_allowed
      type: string
      description: '* `method_not_allowed` - Method Not Allowed'
    ErrorResponse415:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error415'
      required:
      - errors
      - type
    Error404:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode404Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    PublicOverviewSignalsSection:
      type: object
      properties:
        windowDays:
          type: integer
        estimated:
          type: boolean
          description: 'Always true: mart figures are sampling-weighted estimates.'
        sessions:
          type: integer
        conversions:
          type: integer
        aiAssistantReferrals:
          type: integer
        botHits:
          type: integer
      required:
      - aiAssistantReferrals
      - botHits
      - conversions
      - estimated
      - sessions
      - windowDays
    ErrorResponse401:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error401'
      required:
      - errors
      - type
    ErrorResponse406:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error406'
      required:
      - errors
      - type
    ErrorResponse500:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ServerErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error500'
      required:
      - errors
      - type
    ErrorCode401Enum:
      enum:
      - authentication_failed
      - not_authenticated
      type: string
      description: '* `authentication_failed` - Authentication Failed

        * `not_authenticated` - Not Authenticated'
    Error429:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode429Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    PublicBrandOverview:
      type: object
      description: 'One orientation read. Every section is optional: `sections` selects them.'
      properties:
        brandSlug:
          type: string
        name:
          type: string
        websiteUrl:
          type: string
        locales:
          type: array
          items:
            type: string
          description: The languages the site serves, the default first. Every page is served in each of them.
        pages:
          $ref: '#/components/schemas/PublicOverviewPagesSection'
        opportunities:
          $ref: '#/components/schemas/PublicOverviewOpportunitiesSection'
        coverage:
          $ref: '#/components/schemas/PublicOverviewCoverageSection'
        visibility:
          $ref: '#/components/schemas/PublicOverviewVisibilitySection'
        signals:
          $ref: '#/components/schemas/PublicOverviewSignalsSection'
        nextActions:
          type: array
          items:
            type: string
      required:
      - brandSlug
      - locales
      - name
      - websiteUrl
    ErrorCode500Enum:
      enum:
      - error
      type: string
      description: '* `error` - Error'
    ErrorCode429Enum:
      enum:
      - throttled
      type: string
      description: '* `throttled` - Throttled'
    PublicOverviewPagesSection:
      type: object
      properties:
        total:
          type: integer
        byStatus:
          type: object
          additionalProperties:
            type: integer
        liveSiteUrl:
          type:
          - string
          - 'null'
        recentlyUpdated:
          type: array
          items:
            $ref: '#/components/schemas/PublicOverviewPage'
      required:
      - byStatus
      - liveSiteUrl
      - recentlyUpdated
      - total
    PublicBrandsListErrorResponse400:
      oneOf:
      - $ref: '#/components/schemas/ParseErrorResponse'
      discriminator:
        propertyName: type
        mapping:
          client_error: '#/components/schemas/ParseErrorResponse'
    PublicBrandList:
      type: object
      description: 'The schema for what ``paginated`` builds. Kept beside it deliberately.


        A list operation whose ``responses`` named the *item* serializer with

        ``many=True`` published a bare array while the runtime returned this object,

        so a generated client broke on its first call. Subclasses add ``items``:

        each operation needs its own named component or the item type is erased.'
      properties:
        total:
          type: integer
          description: Rows matching the query, before `limit` and `offset`.
        offset:
          type: integer
          description: Rows skipped. Echoed back so a caller can page without bookkeeping.
        limit:
          type: integer
          description: Cap actually applied, which may be lower than the one requested.
        note:
          type: string
          description: How to narrow, when the cap hid rows. Empty when the response is the whole answer.
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicBrandSummary'
      required:
      - items
      - limit
      - note
      - offset
      - total
    PublicOverviewPage:
      type: object
      properties:
        urlPath:
          type: string
        title:
          type: string
        status:
          type: string
      required:
      - status
      - title
      - urlPath
    ClientErrorEnum:
      enum:
      - client_error
      type: string
      description: '* `client_error` - Client Error'
    PublicOverviewOpportunitiesSection:
      type: object
      properties:
        totalOpen:
          type: integer
        byStatus:
          type: object
          additionalProperties:
            type: integer
        top:
          type: array
          items:
            type: object
            additionalProperties: {}
      required:
      - byStatus
      - top
      - totalOpen
    PublicOverviewCoverageSection:
      type: object
      properties:
        themesTracked:
          type: integer
        covered:
          type: integer
        gaps:
          type: integer
        topGaps:
          type: array
          items:
            $ref: '#/components/schemas/PublicCoverageGap'
      required:
      - covered
      - gaps
      - themesTracked
      - topGaps
    PublicKpi:
      type: object
      properties:
        value:
          type:
          - number
          - 'null'
          format: double
        previous:
          type:
          - number
          - 'null'
          format: double
        of:
          type:
          - integer
          - 'null'
      required:
      - previous
      - value
    Error401:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode401Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
  headers:
    Retry-After:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimit-Reset:
      description: Seconds until the budget has room again.
      schema:
        type: integer
    RateLimit-Limit:
      description: Requests allowed per window, for the tightest budget this request drew on.
      schema:
        type: integer
    RateLimit-Policy:
      description: The budget as `<limit>;w=<window seconds>`, e.g. `600;w=60`.
      schema:
        type: string
  securitySchemes:
    tenantApiKeyAuth:
      type: http
      scheme: bearer