> ## Documentation Index
> Fetch the complete documentation index at: https://geoptie.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# One advertiser in detail

> One advertiser on this brand's prompts: its totals and rank, its ads per day next to the other top advertisers, and the prompts it advertised on. For its ads themselves, use `/ads/creatives` with `advertiser_key`.



## OpenAPI

````yaml /openapi.json get /v1/brands/{id}/ads/advertisers/{advertiserKey}
openapi: 3.1.0
info:
  title: Geoptie API
  version: 1.0.0
  summary: Read and manage your AI-search visibility data.
  description: >-
    Everything the Geoptie dashboard can do, over HTTP.


    **Authentication.** Every request needs an API key as `Authorization: Bearer
    <key>`, and the workspace must have an active or trialing subscription. Keys
    are created in the dashboard and scoped to one workspace.


    **Pagination** is cursor-based. Pass `next_cursor` back as `cursor` and stop
    when `has_more` is false. The cursor is opaque; do not parse it.


    **Dates** are ISO 8601. `from` is inclusive, `to` is exclusive. Omitting
    both gives the last 30 days.


    **Limits** exist to stop runaway clients, not to meter you: there is no
    monthly request ceiling. Every response carries `X-RateLimit-*`, and
    endpoints that spend money carry `X-Endpoint-*` as well. A 429 names which
    limit was hit.


    **Errors** always carry a stable `error.code`. Match on that, never on the
    message text. A verb that an endpoint does not declare returns 405
    `method_not_allowed`.
  contact:
    name: Geoptie support
    email: support@geoptie.com
servers:
  - url: https://api.geoptie.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Brands
    description: The brands you track. A brand owns its prompts, engines and country.
  - name: Prompts
    description: >-
      The questions you track across engines, the answers they returned, and the
      brands named in those answers. Plan limits apply to how many you can
      track.
  - name: Visibility
    description: How often and how prominently a brand appears in engine answers.
  - name: Citations
    description: Which pages engines cited when answering your prompts.
  - name: Ads
    description: >-
      The sponsored ads ChatGPT shows in answers to your prompts: who
      advertises, the ads themselves, and which prompts and answers carry them.
  - name: Competitors
    description: >-
      Your share of voice against the other brands appearing in your prompts,
      the tracked set that share of voice is computed over, and per-competitor
      trends.
  - name: Topics
    description: Optional grouping for prompts within a brand.
  - name: Recommendations
    description: Generated actions for improving visibility, and their lifecycle.
  - name: Audit reports
    description: On-demand GEO analysis of a single URL.
  - name: Content generations
    description: >-
      New articles, written from the pages engines already cite for the prompts
      you track. Research a brief first, then write the article from it.
  - name: Content optimizations
    description: >-
      Pages you already have, scored for AI search with the specific changes
      that would raise the score.
paths:
  /v1/brands/{id}/ads/advertisers/{advertiserKey}:
    get:
      tags:
        - Ads
      summary: One advertiser in detail
      description: >-
        One advertiser on this brand's prompts: its totals and rank, its ads per
        day next to the other top advertisers, and the prompts it advertised on.
        For its ads themselves, use `/ads/creatives` with `advertiser_key`.
      operationId: getAdAdvertiser
      parameters:
        - name: id
          in: path
          required: true
          description: Brand id.
          schema:
            type: string
            format: uuid
          example: b7c1e5a0-4f3d-42a8-9c6b-1e8d5a2f7043
        - name: advertiserKey
          in: path
          required: true
          description: An `advertiser_key`, percent-encoded.
          schema:
            type: string
          example: globex.com
        - name: engine
          in: query
          required: false
          description: Ads are tracked on ChatGPT only, so this is `chatgpt` or omitted.
          schema:
            type: string
            enum:
              - chatgpt
        - name: from
          in: query
          required: false
          description: Inclusive start date. Defaults to 30 days before `to`.
          schema:
            type: string
            format: date
          example: '2026-11-08'
        - name: to
          in: query
          required: false
          description: Exclusive end date. Defaults to tomorrow.
          schema:
            type: string
            format: date
          example: '2026-11-11'
        - name: country
          in: query
          required: false
          description: >-
            Restrict to one market: a two-letter code, or `global` for checks
            run without a market. The summary's `markets` lists the values this
            brand has.
          schema:
            type: string
          example: US
        - name: topic_id
          in: query
          required: false
          explode: true
          description: Repeatable. Restrict to prompts in these topics.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: branding
          in: query
          required: false
          description: >-
            Restrict to prompts that name this brand (`branded`) or to those
            that do not (`non_branded`). Omit, or `all`, for every prompt.
          schema:
            type: string
            enum:
              - all
              - branded
              - non_branded
            default: all
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/AdAdvertiserDetail'
              example:
                data:
                  from: '2026-11-08'
                  to: '2026-11-11'
                  engine: chatgpt
                  filters:
                    country: null
                    topic_ids: []
                    branding: all
                  advertiser:
                    advertiser_key: globex.com
                    name: Globex
                    domain: globex.com
                    domains:
                      - globex.com
                      - try.globex.com
                    is_competitor: true
                    is_own: false
                  totals:
                    ads: 6
                    share_pct: 21.4
                    rank: 1
                    of_advertisers: 9
                    prompts: 3
                    creatives: 2
                    first_seen: '2026-11-08'
                    last_seen: '2026-11-10'
                  series:
                    - date: '2026-11-08'
                      ads: 2
                    - date: '2026-11-09'
                      ads: 3
                    - date: '2026-11-10'
                      ads: 1
                  peers:
                    - advertiser_key: initech.com
                      name: Initech
                      ads: 5
                      series:
                        - date: '2026-11-08'
                          ads: 2
                        - date: '2026-11-09'
                          ads: 2
                        - date: '2026-11-10'
                          ads: 1
                  prompts:
                    - prompt_id: 3f9a2c14-8b7e-4d61-a052-c7e4b9138265
                      prompt_text: best project management software for small teams
                      ads: 3
                      answers: 3
                      pct_of_answers: 100
                    - prompt_id: 7b1e4d90-2c3a-4f86-9e15-0a6d8c2b4f71
                      prompt_text: alternatives to spreadsheets for tracking projects
                      ads: 2
                      answers: 3
                      pct_of_answers: 66.7
                    - prompt_id: c2d85f3a-6e19-4b07-8a4c-5f9e1d3b7a20
                      prompt_text: project management tool with time tracking
                      ads: 1
                      answers: 3
                      pct_of_answers: 33.3
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '402':
          $ref: '#/components/responses/E402'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          $ref: '#/components/responses/E404'
        '429':
          $ref: '#/components/responses/E429'
        '500':
          $ref: '#/components/responses/E500'
components:
  schemas:
    AdAdvertiserDetail:
      type: object
      properties:
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        engine:
          type: string
          enum:
            - chatgpt
        filters:
          $ref: '#/components/schemas/AdsFilters'
        advertiser:
          type: object
          properties:
            advertiser_key:
              $ref: '#/components/schemas/AdvertiserKey'
            name:
              type:
                - string
                - 'null'
            domain:
              type:
                - string
                - 'null'
            domains:
              type: array
              items:
                type: string
              description: Its most common landing domains, up to 5.
            is_competitor:
              type: boolean
            is_own:
              type: boolean
        totals:
          type: object
          properties:
            ads:
              type: integer
            share_pct:
              type:
                - number
                - 'null'
            rank:
              type:
                - integer
                - 'null'
            of_advertisers:
              type:
                - integer
                - 'null'
            prompts:
              type: integer
            creatives:
              type: integer
            first_seen:
              type:
                - string
                - 'null'
              format: date
            last_seen:
              type:
                - string
                - 'null'
              format: date
        series:
          type: array
          items:
            $ref: '#/components/schemas/AdSeriesPoint'
          description: Its ads per day, every day of the window.
        peers:
          type: array
          description: The top other advertisers, for comparison.
          items:
            type: object
            properties:
              advertiser_key:
                $ref: '#/components/schemas/AdvertiserKey'
              name:
                type:
                  - string
                  - 'null'
              ads:
                type: integer
              series:
                type: array
                items:
                  $ref: '#/components/schemas/AdSeriesPoint'
        prompts:
          type: array
          description: The prompts it advertised on.
          items:
            type: object
            properties:
              prompt_id:
                type: string
                format: uuid
              prompt_text:
                type: string
              ads:
                type: integer
              answers:
                type: integer
                description: ChatGPT answers checked for the prompt.
              pct_of_answers:
                type:
                  - number
                  - 'null'
                description: 0-100. Share of those answers that carried its ad.
    AdsFilters:
      type: object
      properties:
        country:
          type:
            - string
            - 'null'
        topic_ids:
          type: array
          items:
            type: string
            format: uuid
        branding:
          type: string
          enum:
            - all
            - branded
            - non_branded
    AdvertiserKey:
      type: string
      description: >-
        Stable advertiser id. Usually the advertiser's domain (`globex.com`);
        `name:` plus a folded name when the ad links through a redirect or a
        marketplace. Treat it as opaque and pass it back unchanged,
        percent-encoded in a path.
      example: globex.com
    AdSeriesPoint:
      type: object
      properties:
        date:
          type: string
          format: date
        ads:
          type: integer
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine code. Match on this, not the message.
            message:
              type: string
      example:
        error:
          code: not_found
          message: No such brand in this workspace.
  responses:
    E400:
      description: >-
        Bad request. `missing_parameter`, `invalid_parameter`,
        `invalid_request`, `invalid_engine` or `invalid_date`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_date
              message: Dates must be ISO 8601, e.g. 2026-08-01.
    E401:
      description: '`missing_api_key` or `invalid_api_key`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: This API key is not valid or has been revoked.
    E402:
      description: >-
        `subscription_required`. The workspace has no active or trialing
        subscription.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: subscription_required
              message: >-
                This workspace does not have an active subscription. API access
                requires an active or trialing plan.
    E403:
      description: '`plan_not_eligible` or `forbidden`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: This workspace cannot perform that action.
    E404:
      description: '`not_found`. Also returned for records belonging to another workspace.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: No such brand in this workspace.
    E429:
      description: >-
        `rate_limited`, `quota_exceeded`, `endpoint_rate_limited` or
        `concurrency_limited`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit of 120 requests per minute exceeded.
    E500:
      description: '`internal_error`. Quote the `X-Request-Id` when reporting it.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: internal_error
              message: Something went wrong on our side.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, e.g. `Authorization: Bearer gp_live_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.