> ## 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.

# Get an optimization

> One analysis, with its score and the fixes suggested for that page.



## OpenAPI

````yaml /openapi.json get /v1/brands/{id}/optimizations/{optId}
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: Competitors
    description: Your share of voice against the other brands appearing in your prompts.
  - 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}/optimizations/{optId}:
    get:
      tags:
        - Content optimizations
      summary: Get an optimization
      description: One analysis, with its score and the fixes suggested for that page.
      operationId: getOptimization
      parameters:
        - name: id
          in: path
          required: true
          description: Brand id.
          schema:
            type: string
            format: uuid
          example: b7c1e5a0-4f3d-42a8-9c6b-1e8d5a2f7043
        - name: optId
          in: path
          required: true
          description: Optimization id.
          schema:
            type: string
            format: uuid
          example: 8e5c2b40-6d19-4a73-95f8-2b7d1e463c05
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Optimization'
        '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:
    Optimization:
      type: object
      description: >-
        A page scored for AI search. Fields the list query does not select are
        OMITTED rather than returned as null, so `draft_md` and `analysis`
        appear only on a single fetch.
      properties:
        id:
          type: string
          format: uuid
        brand_id:
          type: string
          format: uuid
        status:
          type:
            - string
            - 'null'
        title:
          type:
            - string
            - 'null'
        source_type:
          type:
            - string
            - 'null'
          description: Whether the content came from a URL or was pasted in.
        source_url:
          type:
            - string
            - 'null'
          description: The page that was analysed, when one was given.
        geo_score:
          type:
            - number
            - 'null'
          description: 0-100 overall.
        draft_md:
          type:
            - string
            - 'null'
          description: The content that was analysed, as markdown. Single fetch only.
        analysis:
          description: Single fetch only.
          oneOf:
            - $ref: '#/components/schemas/OptimizationAnalysis'
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    OptimizationAnalysis:
      type: object
      description: The score and the changes that would raise it.
      properties:
        summary:
          type:
            - string
            - 'null'
          description: A short readable verdict on the page.
        geo_readiness_level:
          type:
            - string
            - 'null'
          enum:
            - AI-Optimized
            - AI-Ready
            - Needs AI Optimization
            - Not AI-Optimized
          description: The overall score expressed as a band.
        content_truncated:
          type: boolean
          description: >-
            True when the page was longer than could be analysed in one pass, so
            the score covers only the part that was.
        breakdown:
          type: array
          items:
            $ref: '#/components/schemas/OptimizationBreakdown'
          description: The score broken down by aspect.
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/OptimizationFix'
          description: The changes worth making, highest impact first.
    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
    OptimizationBreakdown:
      type: object
      description: How the page scored on one aspect.
      properties:
        dimension:
          oneOf:
            - $ref: '#/components/schemas/OptimizationDimension'
            - type: 'null'
        score:
          type:
            - number
            - 'null'
          description: 0-100 for this aspect.
        status:
          type:
            - string
            - 'null'
          description: What the score is based on, in a sentence.
    OptimizationFix:
      type: object
      description: One change to make, and what it is worth.
      properties:
        title:
          type:
            - string
            - 'null'
          description: The change, in a few words.
        issue:
          type:
            - string
            - 'null'
          description: What is wrong today.
        impact:
          type:
            - string
            - 'null'
          enum:
            - high
            - medium
            - low
        dimension:
          description: The aspect this change improves.
          oneOf:
            - $ref: '#/components/schemas/OptimizationDimension'
            - type: 'null'
        excerpt:
          type:
            - string
            - 'null'
          description: The passage to change, when the change is to a specific one.
        rewrite:
          type:
            - string
            - 'null'
          description: Suggested replacement wording.
        projected_delta:
          type:
            - number
            - 'null'
          description: >-
            Estimated points this would add to the overall score. An estimate,
            not a measurement, useful mainly for deciding what to do first.
    OptimizationDimension:
      type: string
      description: The aspect of the page being scored.
      enum:
        - content_structure
        - factual_density
        - semantic_clarity
        - answer_completeness
        - authority_signals
        - competitive_differentiation
  responses:
    E400:
      description: >-
        Bad request. `missing_parameter`, `invalid_request`, `invalid_engine` or
        `invalid_date`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E401:
      description: '`missing_api_key` or `invalid_api_key`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E402:
      description: >-
        `subscription_required`. The workspace has no active or trialing
        subscription.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E403:
      description: '`plan_not_eligible` or `forbidden`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E404:
      description: '`not_found`. Also returned for records belonging to another workspace.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E429:
      description: >-
        `rate_limited`, `quota_exceeded`, `endpoint_rate_limited` or
        `concurrency_limited`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E500:
      description: '`internal_error`. Quote the `X-Request-Id` when reporting it.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, e.g. `Authorization: Bearer gp_live_...`.'

````