> ## 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. # Brand visibility > How often and how prominently this brand appears in engine answers, day by day, with a summary for the window. Narrow it to one engine, a topic, or a single prompt. ## OpenAPI ````yaml /openapi.json get /v1/brands/{id}/visibility 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 `, 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}/visibility: get: tags: - Visibility summary: Brand visibility description: >- How often and how prominently this brand appears in engine answers, day by day, with a summary for the window. Narrow it to one engine, a topic, or a single prompt. operationId: getBrandVisibility parameters: - name: id in: path required: true description: Brand id. schema: type: string format: uuid example: b7c1e5a0-4f3d-42a8-9c6b-1e8d5a2f7043 - name: from in: query required: false description: Inclusive start date. Defaults to 30 days before `to`. schema: type: string format: date example: '2026-08-01' - name: to in: query required: false description: Exclusive end date. Defaults to tomorrow. schema: type: string format: date example: '2026-09-01' - name: engine in: query required: false explode: true description: Repeatable. Omit for the all-engine rollup. schema: type: array items: $ref: '#/components/schemas/Engine' example: - chatgpt - 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: prompt_id in: query required: false description: >- Restrict to a single prompt. Not repeatable, and cannot be combined with `topic_id`. For metrics across many prompts use `GET /v1/brands/{id}/prompts?include=metrics`. schema: type: string format: uuid example: 3f9a2c14-8b7e-4d61-a052-c7e4b9138265 - name: trends in: query required: false description: Set false for the summary only. schema: type: boolean default: true - name: compare in: query required: false description: Adds the previous equal-length period and deltas. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/BrandVisibility' '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: Engine: type: string description: Stable public engine identifier. Internal model names are never exposed. enum: - chatgpt - claude - perplexity - gemini - google_ai_overviews - google_ai_mode - copilot BrandVisibility: type: object properties: brand: type: object properties: id: type: string format: uuid name: type: string domain: type: - string - 'null' period: type: object properties: from: type: string format: date to: type: string format: date filters: type: object properties: engines: type: array items: $ref: '#/components/schemas/Engine' topic_ids: type: array items: type: string format: uuid summary: $ref: '#/components/schemas/Metrics' trends: type: array items: $ref: '#/components/schemas/TrendPoint' description: Omitted when `trends=false`. previous: type: object description: Only when `compare=true`. properties: period: type: object summary: $ref: '#/components/schemas/Metrics' changes: type: object description: Only when `compare=true`. Absolute deltas. additionalProperties: type: - number - 'null' Metrics: type: object properties: visibility_score: type: - number - 'null' description: 0-100. share_of_voice: type: - number - 'null' description: 0-100. detection_rate: type: - number - 'null' description: 0-100. Share of analysed responses that mention the brand. top3_visibility: type: - number - 'null' description: 0-100. avg_position: type: - number - 'null' description: 1 is first. Lower is better. Null when never mentioned. avg_sentiment: type: - number - 'null' description: '-1 to 1.' mention_count: type: integer citation_count: type: integer responses_analyzed: type: integer responses_with_brand: type: integer TrendPoint: type: object properties: date: type: string format: date no_data: type: boolean description: >- True when no snapshot exists for that day. Distinguishes 'measured and invisible' from 'not measured'. visibility_score: type: - number - 'null' description: 0-100. share_of_voice: type: - number - 'null' description: 0-100. detection_rate: type: - number - 'null' description: 0-100. Share of analysed responses that mention the brand. top3_visibility: type: - number - 'null' description: 0-100. avg_position: type: - number - 'null' description: 1 is first. Lower is better. Null when never mentioned. avg_sentiment: type: - number - 'null' description: '-1 to 1.' mention_count: type: integer citation_count: type: integer responses_analyzed: type: integer responses_with_brand: 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 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_...`.' ````