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

# 单条提示词概览

> caliber and kpi_state distinguish legacy, mention-based and unavailable KPIs; with kpi_state own_pending the brand mention counts, rates and rank are null rather than placeholder zeros. Rates use percentages without conversion. Custom windows over 90 days are clamped by the tool; window echoes the actual interval. Source domains include the first page and total counts. GET with body payload — no resources created. Billed per call at the price in x-geoly-cost (the same as the matching GEOly MCP tool).



## OpenAPI

````yaml api-reference/openapi.json POST /api/v1/reports/prompt-overview
openapi: 3.1.0
info:
  title: GEOly Data API
  version: '1'
  description: >-
    Typed endpoints of the GEOly Data API (`x-geoly-stability: stable`): the
    account behind the key (GET /api/v1/quota, /api/v1/brand), the brand catalog
    (GET /api/v1/topics, /api/v1/prompts), monitoring records (GET
    /api/v1/prompts/{prompt_id}/records, /api/v1/records/{record_id}) and the
    incremental record feed (GET /api/v1/records), writes (POST /api/v1/prompts,
    POST /api/v1/prompts/{prompt_id}/runs) and windowed reports (POST
    /api/v1/reports/*). Authenticate with an API key bound to one brand; the
    brand is implied by the key and never appears in paths.


    Stability: within /api/v1 the shape and meaning of every declared field is
    stable — fields are never removed, renamed or retyped, units never change,
    and enums only grow (response enums are open: ignore unknown values and
    unknown fields). Metric definitions follow the product and are recorded in
    the changelog. Breaking changes only ship under /api/v2.


    Envelope: `{ data, page?, meta }`. `meta.quota` is the billing outcome of
    the call; `meta.schema_conformant` is false only if the report output
    drifted from this document (the data is still returned).


    Pagination: send `limit` (and `cursor` from `page.next_cursor` for the next
    page, with exactly the same filters). `page.next_cursor === null` is the
    only end-of-list signal; `page.capped: true` means the position limit was
    reached before the end. GET /api/v1/prompts uses a true keyset cursor
    (ordered by created_at, id): a row whose sort key is unchanged and that
    still matches the filters is never skipped or repeated because other rows
    were added or archived meanwhile, and there is no position limit. It is not
    a snapshot: every page re-applies the filters, so a row archived before you
    reach it drops out of an active listing. `x-geoly-pagination` describes each
    list.


    Errors use one envelope `{error:{code,message,details?},meta}`; `error.code`
    is drawn from the closed list in `x-geoly-error-codes`. Branch on the HTTP
    status and `error.code`, never on `message`. Stable keys of `error.details`:
    errors[] ({param, reason, allowed?, message}), reason, required,
    retry_after_seconds, max_bytes, actual_bytes, _quota, and resource / id (404
    NOT_FOUND of a single-resource endpoint such as GET
    /api/v1/prompts/{prompt_id}).


    Billing: each call is billed at the price in `x-geoly-cost` ({tier, base,
    unit, long_window_multiplier, guard_rpm}: nominal price per call in credits,
    the same as the matching GEOly MCP tool (GET /api/v1/records has none: it is
    offered only on this API, so its price and guard are its own), against the
    MCP credits pool; tier "free" with base 0 = not charged — this includes
    operations whose matching MCP tool is registered as not charged
    (charged:false: POST /api/v1/prompts and POST
    /api/v1/prompts/{prompt_id}/runs), so no nominal price is declared for them;
    guard_rpm is the per-organization requests-per-minute guard of that endpoint
    — counted per organization together with the same organization's calls of
    the matching GEOly MCP tool on the other surfaces (MCP, Agent API)). The
    billing outcome of every call is in `meta.quota`. A monitoring run still
    consumes monitoring credits, a separate pool, as described on that
    operation.


    The HTTP tool wrappers under /api/v1/tools and /api/v1/tools/{tool} are
    retired: every method answers 410 TOOL_SURFACE_RETIRED, and for a known tool
    details.replacement names the resource endpoint. Use these resource
    endpoints. MCP and Agent API remain available.
servers:
  - url: https://app.geoly.ai
security:
  - bearerAuth: []
tags:
  - name: Records
    description: Monitoring records and optional full answer text.
  - name: Account
    description: The organization, credits and brand behind this API key.
  - name: Catalog
    description: >-
      Topics and prompts of the brand behind this API key (GET, no metrics
      computed; the price of each operation is in x-geoly-cost).
  - name: Reports
    description: >-
      Windowed brand-visibility reports (POST with a JSON body; nothing is
      created).
paths:
  /api/v1/reports/prompt-overview:
    post:
      tags:
        - Reports
      summary: Window overview of one prompt
      description: >-
        caliber and kpi_state distinguish legacy, mention-based and unavailable
        KPIs; with kpi_state own_pending the brand mention counts, rates and
        rank are null rather than placeholder zeros. Rates use percentages
        without conversion. Custom windows over 90 days are clamped by the tool;
        window echoes the actual interval. Source domains include the first page
        and total counts. GET with body payload — no resources created. Billed
        per call at the price in x-geoly-cost (the same as the matching GEOly
        MCP tool).
      operationId: runPromptOverviewReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunPromptOverviewReportRequest'
      responses:
        '200':
          description: >-
            The prompt-overview report. `data` follows PromptOverviewReport when
            meta.schema_conformant is true.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptOverviewReportEnvelope'
        '400':
          description: >-
            INVALID_BODY / INVALID_ARGUMENT (unknown field, wrong type, invalid
            enum value, missing required field — details.errors[] lists each
            {param, reason, allowed?}; or an argument the report could only
            reject after looking it up) / INVALID_CURSOR (the cursor belongs to
            another query — drop it and start over) / FAILED_PRECONDITION
            (details.reason: platform_not_enabled, locale_required,
            request_rejected). Schema-level rejections are not charged; see
            meta.quota for the rest.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: 'UNAUTHORIZED: missing or invalid API key.'
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '402':
          description: >-
            QUOTA_EXCEEDED / SUBSCRIPTION_INACTIVE / ORG_NOT_ELIGIBLE. Not
            charged.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            API_KEY_BRAND_REQUIRED (the key is not bound to a brand) /
            PERMISSION_DENIED (the key lacks the read permission in
            x-geoly-required-permission; details.required names it). Not
            charged.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: >-
            REPORT_NOT_FOUND (unknown report name; not charged) / NOT_FOUND (a
            referenced id does not exist for this brand; billing in
            meta.quota.charge).
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '413':
          description: 'PAYLOAD_TOO_LARGE: request body exceeds 64 KB.'
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '415':
          description: 'UNSUPPORTED_MEDIA_TYPE: send the body as application/json.'
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: >-
            QUERY_TOO_EXPENSIVE (narrow the window / filters) /
            RESPONSE_TOO_LARGE (the response exceeds 4 MB — lower limit or
            narrow the filters; decided before settlement, not charged).
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: >-
            RATE_LIMITED / GUARDED_RATE_LIMITED / BUSY / BUDGET_EXCEEDED. Not
            charged; honor Retry-After and pace with X-DB-Budget-*.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: >-
            INTERNAL_ERROR: unexpected server error (not charged). Retry once
            with backoff; report the Request-Id if it persists.
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: >-
            TOOL_TIMEOUT / OVERLOADED / CIRCUIT_OPEN / TOOL_FAILED. Not charged;
            retry later, honoring Retry-After when present. (502 / 504 are never
            used.)
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            GEOly-API-Version:
              $ref: '#/components/headers/GEOly-API-Version'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-DB-Budget-Limit:
              $ref: '#/components/headers/X-DB-Budget-Limit'
            X-DB-Budget-Used:
              $ref: '#/components/headers/X-DB-Budget-Used'
            X-DB-Budget-Reset:
              $ref: '#/components/headers/X-DB-Budget-Reset'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    RunPromptOverviewReportRequest:
      type: object
      properties:
        prompt_id:
          description: Resource id for this API key brand.
          type: string
          minLength: 1
          maxLength: 64
        time_range:
          default: 30d
          type: string
          enum:
            - 7d
            - 30d
            - custom
        start_date:
          description: Start of a custom window (UTC+8 business day, YYYY-MM-DD).
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        end_date:
          description: End of a custom window (UTC+8 business day, YYYY-MM-DD).
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        platform:
          default: all
          type: string
          enum:
            - all
            - chatgpt
            - perplexity
            - gemini
            - google_ai
            - copilot
            - google_ai_overview
      required:
        - prompt_id
      additionalProperties: false
    PromptOverviewReportEnvelope:
      type: object
      properties:
        data:
          oneOf:
            - $ref: '#/components/schemas/PromptOverviewReport'
            - type: 'null'
          description: >-
            The prompt-overview report. null only when meta.schema_conformant is
            false and the report output could not be mapped.
        meta:
          $ref: '#/components/schemas/CuratedMeta'
      required:
        - data
        - meta
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: '[Extensible enum] One of x-geoly-error-codes.'
              examples:
                - INVALID_BODY
                - INVALID_ARGUMENT
                - INVALID_CURSOR
                - IDEMPOTENCY_KEY_INVALID
                - FAILED_PRECONDITION
                - UNAUTHORIZED
                - SUBSCRIPTION_INACTIVE
                - QUOTA_EXCEEDED
                - ORG_NOT_ELIGIBLE
                - PLAN_LIMIT_REACHED
                - API_KEY_BRAND_REQUIRED
                - ORG_SELECTION_REQUIRED
                - ORGANIZATION_REQUIRED
                - PERMISSION_DENIED
                - REPORT_NOT_FOUND
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - IDEMPOTENCY_KEY_REUSED
                - REQUEST_IN_PROGRESS
                - IDEMPOTENCY_OUTCOME_UNKNOWN
                - TOOL_SURFACE_RETIRED
                - PAYLOAD_TOO_LARGE
                - UNSUPPORTED_MEDIA_TYPE
                - QUERY_TOO_EXPENSIVE
                - RESPONSE_TOO_LARGE
                - RATE_LIMITED
                - GUARDED_RATE_LIMITED
                - BUSY
                - BUDGET_EXCEEDED
                - INTERNAL_ERROR
                - TOOL_TIMEOUT
                - OVERLOADED
                - CIRCUIT_OPEN
                - TOOL_FAILED
                - FEED_NOT_READY
                - IDEMPOTENCY_UNAVAILABLE
            message:
              type: string
              description: For humans; do not parse.
            details:
              type: object
              description: >-
                Stable keys: errors[] ({param, reason, allowed?, message}) on
                INVALID_ARGUMENT; reason; required (PERMISSION_DENIED);
                retry_after_seconds (429); max_bytes / actual_bytes (413 / 422);
                _quota (receipt); resource / id (404 NOT_FOUND of a
                single-resource endpoint). Other keys are informational and may
                change.
          required:
            - code
            - message
        meta:
          $ref: '#/components/schemas/CuratedErrorMeta'
      required:
        - error
        - meta
    PromptOverviewReport:
      type: object
      properties:
        prompt:
          type: object
          properties:
            id:
              type: string
            text:
              type: string
            country:
              type:
                - string
                - 'null'
            is_active:
              type: boolean
            topic_id:
              type:
                - string
                - 'null'
            topic_name:
              type:
                - string
                - 'null'
            is_branded:
              type: boolean
            created_at:
              type: string
              format: date-time
          required:
            - id
            - text
            - country
            - is_active
            - topic_id
            - topic_name
            - is_branded
            - created_at
          additionalProperties: {}
        platform:
          type: string
        window:
          type: object
          properties:
            time_range:
              type: string
              examples:
                - 7d
                - 30d
                - custom
              description: >-
                [Extensible enum] Known values: "7d", "30d", "custom"; more may
                be added.
            start_at:
              type: string
              format: date-time
            end_at:
              type:
                - string
                - 'null'
              format: date-time
            end_bounded:
              type: boolean
          required:
            - time_range
            - start_at
            - end_at
            - end_bounded
          additionalProperties: {}
        caliber:
          type: string
          examples:
            - legacy
            - mention
          description: >-
            [Extensible enum] Known values: "legacy", "mention"; more may be
            added.
        kpi_state:
          type: string
          examples:
            - ok
            - no_data
            - own_pending
          description: >-
            [Extensible enum] Known values: "ok", "no_data", "own_pending"; more
            may be added.
        brand:
          type: object
          properties:
            completed_records:
              type: integer
              minimum: 0
            mentioned_records:
              type:
                - integer
                - 'null'
              minimum: 0
              description: >-
                Answers in the window that mention your brand. null when
                kpi_state is own_pending: your brand entity is not set up yet,
                so there is no count.
            mention_rate_pct:
              type:
                - number
                - 'null'
              minimum: 0
              maximum: 100
              description: >-
                mentioned_records / completed_records in percent. null when
                kpi_state is no_data or own_pending.
            visibility_score:
              type:
                - number
                - 'null'
              minimum: 0
              maximum: 100
            share_pct:
              type:
                - number
                - 'null'
              minimum: 0
              maximum: 100
            rank:
              type:
                - integer
                - 'null'
              minimum: 1
              description: >-
                Your position among the brands of the window, the same rank the
                app shows. With caliber mention it is ranked against every
                confirmed competitor and is null when every brand scores 0; with
                caliber legacy it is a lower bound when
                competitor_board.total_rows exceeds the rows shown. null when
                kpi_state is no_data or own_pending.
          required:
            - completed_records
            - mentioned_records
            - mention_rate_pct
            - visibility_score
            - share_pct
            - rank
          additionalProperties: {}
        top_competitor:
          type:
            - object
            - 'null'
          properties:
            name:
              type: string
            mention_rate_pct:
              type: number
              minimum: 0
              maximum: 100
          required:
            - name
            - mention_rate_pct
          additionalProperties: {}
        competitor_board:
          type: object
          properties:
            rows:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  visibility_score:
                    type: number
                    minimum: 0
                    maximum: 100
                  share_pct:
                    type:
                      - number
                      - 'null'
                    minimum: 0
                    maximum: 100
                required:
                  - name
                  - visibility_score
                  - share_pct
                additionalProperties: {}
            total_rows:
              type: integer
              minimum: 0
            discovered_competitors:
              type: integer
              minimum: 0
          required:
            - rows
            - total_rows
            - discovered_competitors
          additionalProperties: {}
        platform_matrix:
          type: object
          properties:
            columns:
              type: array
              items:
                type: object
                properties:
                  platform_code:
                    type: string
                  platform_name:
                    type: string
                  completed_records:
                    type: integer
                    minimum: 0
                  filterable:
                    type: boolean
                required:
                  - platform_code
                  - platform_name
                  - completed_records
                  - filterable
                additionalProperties: {}
            brand_mention_rate_pct:
              type:
                - array
                - 'null'
              items:
                type: number
                minimum: 0
                maximum: 100
              description: >-
                Your mention rate per column, in column order. null when
                kpi_state is own_pending.
            competitors:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  mention_rate_pct:
                    type: array
                    items:
                      type: number
                      minimum: 0
                      maximum: 100
                required:
                  - name
                  - mention_rate_pct
                additionalProperties: {}
          required:
            - columns
            - brand_mention_rate_pct
            - competitors
          additionalProperties: {}
        source_domains:
          type: object
          properties:
            status:
              type: string
              examples:
                - ready
                - unavailable
                - computing
              description: >-
                [Extensible enum] Known values: "ready", "unavailable",
                "computing"; more may be added.
            rows:
              type: array
              items:
                type: object
                properties:
                  domain:
                    type: string
                  citations:
                    type: integer
                    minimum: 0
                required:
                  - domain
                  - citations
                additionalProperties: {}
            total_domains:
              type: integer
              minimum: 0
            citations_by_owner:
              type: object
              properties:
                total:
                  type: integer
                  minimum: 0
                brand:
                  type: integer
                  minimum: 0
                competitor:
                  type: integer
                  minimum: 0
                other:
                  type: integer
                  minimum: 0
              required:
                - total
                - brand
                - competitor
                - other
              additionalProperties: {}
            own_domains:
              type: array
              items:
                type: string
          required:
            - status
            - rows
            - total_domains
            - citations_by_owner
            - own_domains
          additionalProperties: {}
        coverage:
          type:
            - object
            - 'null'
          properties:
            floor_date:
              type:
                - string
                - 'null'
              pattern: ^\d{4}-\d{2}-\d{2}$
            clamped:
              type: boolean
          required:
            - floor_date
            - clamped
          additionalProperties: {}
      required:
        - prompt
        - platform
        - window
        - caliber
        - kpi_state
        - brand
        - top_competitor
        - competitor_board
        - platform_matrix
        - source_domains
        - coverage
      additionalProperties: {}
    CuratedMeta:
      type: object
      properties:
        request_id:
          type: string
        report:
          type: string
          description: >-
            Report name for POST /api/v1/reports/{report}; resource labels
            include quota, brand, topics, prompt-catalog, prompt,
            prompt-records, prompt-records-latest, record, record-feed,
            created-prompt and prompt-run.
        duration_ms:
          type: integer
        quota:
          $ref: '#/components/schemas/QuotaMeta'
        schema_conformant:
          type: boolean
          description: >-
            true = data matches the documented schema exactly (every declared
            key present). false = the report output drifted; data is still
            returned as mapped (or null) — treat it as best effort.
      required:
        - request_id
        - report
        - duration_ms
        - schema_conformant
    CuratedErrorMeta:
      type: object
      properties:
        request_id:
          type: string
        report:
          type: string
        duration_ms:
          type: integer
        quota:
          $ref: '#/components/schemas/QuotaMeta'
      required:
        - request_id
    QuotaMeta:
      type: object
      description: >-
        Billing outcome of this call. remaining / resets_at / unlimited are null
        on paths that never reserved credits (free reports, calls rejected
        before execution) — except QUOTA_EXCEEDED, which carries the live
        balance. Absent when the call was rejected before the report ran (schema
        errors, cursor errors, authentication).
      properties:
        cost:
          type: integer
          description: Credits actually charged for this call.
        unlimited:
          type:
            - boolean
            - 'null'
        remaining:
          type:
            - integer
            - 'null'
          description: >-
            Credits left this period; null when unlimited or unknown on this
            path.
        resets_at:
          type:
            - string
            - 'null'
          format: date-time
        charge:
          type: string
          examples:
            - charged
            - min_fee
            - free
            - refunded
            - refund_pending
            - unbilled
          description: >-
            [Extensible enum] charged = normal settlement (per row, or one call
            for a call-priced read — including a not-found from the prompt or
            record detail); min_fee = minimum call fee (no data / not found from
            a per-row report / platform not purchased / missing locale); free =
            free report or endpoint; refunded / refund_pending = failed and
            refunded; unbilled = rejected before execution, or not metered.
        min_fee_reason:
          type:
            - string
            - 'null'
          examples:
            - missing_locale
            - no_data
            - null
          description: '[Extensible enum]'
      required:
        - cost
        - unlimited
        - remaining
        - resets_at
        - charge
        - min_fee_reason
  headers:
    Request-Id:
      description: >-
        Unique id of this request (equals meta.request_id). Include it when
        reporting a problem.
      schema:
        type: string
    GEOly-API-Version:
      description: API contract version. Always "1" on /api/v1.
      schema:
        type: string
    X-RateLimit-Limit:
      description: >-
        Requests allowed per credential in the current one-minute window. Sent
        on every response after the API key has been authenticated; absent on
        errors raised while authenticating (401) and on 405.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Seconds until the current window resets (0–60).
      schema:
        type: integer
    X-DB-Budget-Limit:
      description: >-
        Organization database-seconds budget per rolling 60 minutes. Sent on
        every response after authentication.
      schema:
        type: integer
    X-DB-Budget-Used:
      description: Database seconds used by the organization in the last 60 minutes.
      schema:
        type: integer
    X-DB-Budget-Reset:
      description: Seconds until the oldest usage bucket expires.
      schema:
        type: integer
    Retry-After:
      description: Seconds to wait before retrying (429; 503 when retryable).
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from Settings → Developer → API keys (prefix geom_). Each key is
        bound to one brand.

````

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