Iterant Public: Visibility API

The Public: Visibility API from Iterant — 1 operation(s) for public: visibility.

GitHub OpenAPI

Operations 1

GET /api/v1/public/brands/{brandSlug}/visibility/overview/ Get AI visibility #

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-visibility-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-visibility-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: 'Iterant Public Public: Visibility 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: Visibility'
paths:
  /api/v1/public/brands/{brandSlug}/visibility/overview/:
    get:
      operationId: publicVisibilityOverview
      description: 'One projection per call, selected with `view`:


        - `kpis`: visibility score, share of voice, rank, average position and citation share, each with its previous value

        - `trend`: the same headline numbers over time

        - `share_of_voice`: the entity leaderboard, brand and competitors together

        - `platform_matrix`: the same picture split by assistant

        - `prompt_scores`: per tracked prompt, how often the brand is mentioned

        - `citation_gaps`: domains assistants cite for competitors but not for this brand

        - `top_sources`: what assistants cite most in this category


        Start at `kpis` and follow the weak number into the view that explains it.


        If `enabled` is false, tracking is off for this brand and every row is empty. That is an absence of measurement, not a score of zero.'
      summary: Get AI visibility
      parameters:
      - in: path
        name: brandSlug
        schema:
          type: string
        required: true
      - in: query
        name: limit
        schema:
          type: string
        description: Rows to return, 1-50, default 10.
      - in: query
        name: platform
        schema:
          type: string
          enum:
          - chatgpt
          - gemini
          - google_ai_overview
        description: Restrict to one assistant. Omit to aggregate across all of them.
      - 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: view
        schema:
          type: string
          enum:
          - citation_gaps
          - kpis
          - platform_matrix
          - prompt_scores
          - share_of_voice
          - top_sources
          - trend
          default: kpis
      - in: query
        name: window
        schema:
          type: string
          enum:
          - 28d
          - 7d
          - 90d
          default: 28d
        description: Rolling window ending today.
      tags:
      - 'Public: Visibility'
      security:
      - tenantApiKeyAuth: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicVisibilityOverviewErrorResponse400'
          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/PublicVisibilityReport'
              examples:
                CitationGapsOver28Days:
                  value:
                    brandSlug: orbital-labs
                    enabled: true
                    view: citation_gaps
                    windowDays: 28
                    startDate: '2026-06-29'
                    endDate: '2026-07-26'
                    completedRuns: 490
                    platform: all
                    rows:
                    - domain: g2.com
                      competitorCitations: 12
                      selfCitations: 0
                    note: ''
                  summary: Citation gaps over 28 days
                TrackingNotEnabled:
                  value:
                    brandSlug: verdant-supply
                    enabled: false
                    view: kpis
                    windowDays: 28
                    startDate: null
                    endDate: null
                    completedRuns: 0
                    platform: all
                    rows: []
                    note: AI-visibility tracking is not enabled for this brand, so these rows are empty rather than zero.
                  summary: Tracking not enabled
          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'
    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
    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
    ErrorCode415Enum:
      enum:
      - unsupported_media_type
      type: string
      description: '* `unsupported_media_type` - Unsupported Media Type'
    PublicVisibilityReport:
      type: object
      properties:
        brandSlug:
          type: string
        enabled:
          type: boolean
          description: 'False means tracking is off for this brand: rows are empty because nothing was measured.'
        view:
          type: string
        windowDays:
          type: integer
        startDate:
          type:
          - string
          - 'null'
        endDate:
          type:
          - string
          - 'null'
        completedRuns:
          type: integer
        platform:
          type: string
        rows: {}
        note:
          type: string
      required:
      - brandSlug
      - completedRuns
      - enabled
      - endDate
      - note
      - platform
      - rows
      - startDate
      - view
      - windowDays
    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
    ErrorResponse429:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error429'
      required:
      - errors
      - type
    Error500:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode500Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    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'
    ErrorResponse404:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ClientErrorEnum'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error404'
      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
    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
    Error429:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode429Enum'
        detail:
          type: string
        attr:
          type:
          - string
          - 'null'
      required:
      - attr
      - code
      - detail
    ErrorCode401Enum:
      enum:
      - authentication_failed
      - not_authenticated
      type: string
      description: '* `authentication_failed` - Authentication Failed

        * `not_authenticated` - Not Authenticated'
    ErrorCode429Enum:
      enum:
      - throttled
      type: string
      description: '* `throttled` - Throttled'
    ErrorCode500Enum:
      enum:
      - error
      type: string
      description: '* `error` - Error'
    PublicVisibilityOverviewErrorResponse400:
      oneOf:
      - $ref: '#/components/schemas/ParseErrorResponse'
      discriminator:
        propertyName: type
        mapping:
          client_error: '#/components/schemas/ParseErrorResponse'
    ClientErrorEnum:
      enum:
      - client_error
      type: string
      description: '* `client_error` - Client Error'
    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