> ## 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. # 品牌可见度概览 > Visibility score, mention rate, citation rate, share of voice and the per-platform breakdown for the window — the same numbers as the in-app overview. Every number counts the brands you track (your own brand + the competitors you added) under the current configuration; rank is among tracked brands only. data.kpi_state tells whether the KPIs are computed (ok), there are no counted answers in the window (no_data), the first count is still running (computing — no numbers yet, not 0), or the filtered read failed (unavailable). 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/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/overview: post: tags: - Reports summary: Brand visibility overview (the /performance headline) description: >- Visibility score, mention rate, citation rate, share of voice and the per-platform breakdown for the window — the same numbers as the in-app overview. Every number counts the brands you track (your own brand + the competitors you added) under the current configuration; rank is among tracked brands only. data.kpi_state tells whether the KPIs are computed (ok), there are no counted answers in the window (no_data), the first count is still running (computing — no numbers yet, not 0), or the filtered read failed (unavailable). 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: runOverviewReport requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/RunOverviewReportRequest' responses: '200': description: >- The overview report. `data` follows OverviewReport 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/OverviewReportEnvelope' '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: RunOverviewReportRequest: type: object properties: time_range: description: Rolling window, or "custom" with start_date + end_date. default: 30d type: string enum: - 7d - 30d - 90d - 180d - 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: description: AI platform, or "all". default: all type: string enum: - all - chatgpt - perplexity - gemini - google_ai - copilot - google_ai_overview topic_ids: description: >- Restrict to these topic ids (1–50). "_none" = prompts without a topic. minItems: 1 maxItems: 50 type: array items: type: string minLength: 1 maxLength: 64 country: description: >- ISO-2 country code of the prompts (e.g. US). Must be a country the brand has prompts in. type: string minLength: 1 maxLength: 8 additionalProperties: false OverviewReportEnvelope: type: object properties: data: oneOf: - $ref: '#/components/schemas/OverviewReport' - type: 'null' description: >- The 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 OverviewReport: oneOf: - type: object properties: kpi_state: type: string const: ok window: type: object properties: time_range: type: string examples: - 7d - 30d - 90d - 180d - custom description: >- [Extensible enum] Known values: "7d", "30d", "90d", "180d", "custom"; more may be added. start_at: type: string format: date-time end_at: type: string format: date-time end_bounded: type: boolean required: - time_range - start_at - end_at - end_bounded additionalProperties: {} platform: type: string scope: type: object properties: active: type: boolean topic_ids: type: - array - 'null' items: type: string country: type: - string - 'null' collapsed: type: boolean required: - active - topic_ids - country - collapsed additionalProperties: {} kpi_caliber: type: object properties: mention_rate: type: string examples: - board - fallback description: >- [Extensible enum] Known values: "board", "fallback"; more may be added. share_of_voice: type: string examples: - board - fallback description: >- [Extensible enum] Known values: "board", "fallback"; more may be added. required: - mention_rate - share_of_voice additionalProperties: {} kpi_caliber_pending: type: boolean has_prompts: type: boolean has_completed_records: type: boolean total_mentions: type: integer minimum: 0 ranked_records: type: integer minimum: 0 completed_records: type: integer minimum: 0 share_of_voice: type: - object - 'null' properties: share_pct: type: - number - 'null' minimum: 0 maximum: 100 brand_mentioned_records: type: integer minimum: 0 total_mentioned_records: type: integer minimum: 0 required: - share_pct - brand_mentioned_records - total_mentioned_records additionalProperties: {} share_of_voice_state: type: string examples: - ok - not_ready description: >- [Extensible enum] Known values: "ok", "not_ready"; more may be added. best_platform: type: - object - 'null' properties: platform_code: type: string platform_name: type: string visibility_score: type: number minimum: 0 maximum: 100 required: - platform_code - platform_name - visibility_score additionalProperties: {} worst_platform: type: - object - 'null' properties: platform_code: type: string platform_name: type: string visibility_score: type: number minimum: 0 maximum: 100 required: - platform_code - platform_name - visibility_score additionalProperties: {} platforms: type: array items: type: object properties: platform_code: type: string platform_name: type: string visibility_score: type: - number - 'null' minimum: 0 maximum: 100 mention_rate_pct: type: - number - 'null' minimum: 0 maximum: 100 citation_rate_pct: type: - number - 'null' minimum: 0 maximum: 100 completed_records: type: integer minimum: 0 mentioned_records: type: integer minimum: 0 avg_position: type: - number - 'null' total_mentions: type: integer minimum: 0 required: - platform_code - platform_name - visibility_score - mention_rate_pct - citation_rate_pct - completed_records - mentioned_records - avg_position - total_mentions additionalProperties: {} visibility_score: type: number minimum: 0 maximum: 100 mention_rate_pct: type: number minimum: 0 maximum: 100 citation_rate_pct: type: - number - 'null' minimum: 0 maximum: 100 avg_position: type: - number - 'null' top3_rate_pct: type: number minimum: 0 maximum: 100 required: - kpi_state - window - platform - scope - kpi_caliber - kpi_caliber_pending - has_prompts - has_completed_records - total_mentions - ranked_records - completed_records - share_of_voice - share_of_voice_state - best_platform - worst_platform - platforms - visibility_score - mention_rate_pct - citation_rate_pct - avg_position - top3_rate_pct additionalProperties: {} - type: object properties: kpi_state: type: string const: no_data window: type: object properties: time_range: type: string examples: - 7d - 30d - 90d - 180d - custom description: >- [Extensible enum] Known values: "7d", "30d", "90d", "180d", "custom"; more may be added. start_at: type: string format: date-time end_at: type: string format: date-time end_bounded: type: boolean required: - time_range - start_at - end_at - end_bounded additionalProperties: {} platform: type: string scope: type: object properties: active: type: boolean topic_ids: type: - array - 'null' items: type: string country: type: - string - 'null' collapsed: type: boolean required: - active - topic_ids - country - collapsed additionalProperties: {} kpi_caliber: type: object properties: mention_rate: type: string examples: - board - fallback description: >- [Extensible enum] Known values: "board", "fallback"; more may be added. share_of_voice: type: string examples: - board - fallback description: >- [Extensible enum] Known values: "board", "fallback"; more may be added. required: - mention_rate - share_of_voice additionalProperties: {} kpi_caliber_pending: type: boolean has_prompts: type: boolean has_completed_records: type: boolean total_mentions: type: integer minimum: 0 ranked_records: type: integer minimum: 0 completed_records: type: integer minimum: 0 share_of_voice: type: - object - 'null' properties: share_pct: type: - number - 'null' minimum: 0 maximum: 100 brand_mentioned_records: type: integer minimum: 0 total_mentioned_records: type: integer minimum: 0 required: - share_pct - brand_mentioned_records - total_mentioned_records additionalProperties: {} share_of_voice_state: type: string examples: - ok - not_ready description: >- [Extensible enum] Known values: "ok", "not_ready"; more may be added. best_platform: type: - object - 'null' properties: platform_code: type: string platform_name: type: string visibility_score: type: number minimum: 0 maximum: 100 required: - platform_code - platform_name - visibility_score additionalProperties: {} worst_platform: type: - object - 'null' properties: platform_code: type: string platform_name: type: string visibility_score: type: number minimum: 0 maximum: 100 required: - platform_code - platform_name - visibility_score additionalProperties: {} platforms: type: array items: type: object properties: platform_code: type: string platform_name: type: string visibility_score: type: - number - 'null' minimum: 0 maximum: 100 mention_rate_pct: type: - number - 'null' minimum: 0 maximum: 100 citation_rate_pct: type: - number - 'null' minimum: 0 maximum: 100 completed_records: type: integer minimum: 0 mentioned_records: type: integer minimum: 0 avg_position: type: - number - 'null' total_mentions: type: integer minimum: 0 required: - platform_code - platform_name - visibility_score - mention_rate_pct - citation_rate_pct - completed_records - mentioned_records - avg_position - total_mentions additionalProperties: {} visibility_score: type: 'null' mention_rate_pct: type: 'null' citation_rate_pct: type: 'null' avg_position: type: 'null' top3_rate_pct: type: 'null' required: - kpi_state - window - platform - scope - kpi_caliber - kpi_caliber_pending - has_prompts - has_completed_records - total_mentions - ranked_records - completed_records - share_of_voice - share_of_voice_state - best_platform - worst_platform - platforms - visibility_score - mention_rate_pct - citation_rate_pct - avg_position - top3_rate_pct additionalProperties: {} - type: object properties: kpi_state: type: string const: unavailable window: type: object properties: time_range: type: string examples: - 7d - 30d - 90d - 180d - custom description: >- [Extensible enum] Known values: "7d", "30d", "90d", "180d", "custom"; more may be added. start_at: type: string format: date-time end_at: type: string format: date-time end_bounded: type: boolean required: - time_range - start_at - end_at - end_bounded additionalProperties: {} platform: type: string scope: type: object properties: active: type: boolean topic_ids: type: - array - 'null' items: type: string country: type: - string - 'null' collapsed: type: boolean required: - active - topic_ids - country - collapsed additionalProperties: {} kpi_caliber: type: 'null' kpi_caliber_pending: type: boolean const: false has_prompts: type: 'null' has_completed_records: type: 'null' total_mentions: type: 'null' ranked_records: type: 'null' completed_records: type: 'null' share_of_voice: type: 'null' share_of_voice_state: type: 'null' best_platform: type: 'null' worst_platform: type: 'null' platforms: type: 'null' visibility_score: type: 'null' mention_rate_pct: type: 'null' citation_rate_pct: type: 'null' avg_position: type: 'null' top3_rate_pct: type: 'null' required: - kpi_state - window - platform - scope - kpi_caliber - kpi_caliber_pending - has_prompts - has_completed_records - total_mentions - ranked_records - completed_records - share_of_voice - share_of_voice_state - best_platform - worst_platform - platforms - visibility_score - mention_rate_pct - citation_rate_pct - avg_position - top3_rate_pct additionalProperties: {} - type: object properties: kpi_state: type: string const: computing window: type: object properties: time_range: type: string examples: - 7d - 30d - 90d - 180d - custom description: >- [Extensible enum] Known values: "7d", "30d", "90d", "180d", "custom"; more may be added. start_at: type: string format: date-time end_at: type: string format: date-time end_bounded: type: boolean required: - time_range - start_at - end_at - end_bounded additionalProperties: {} platform: type: string scope: type: object properties: active: type: boolean topic_ids: type: - array - 'null' items: type: string country: type: - string - 'null' collapsed: type: boolean required: - active - topic_ids - country - collapsed additionalProperties: {} kpi_caliber: type: 'null' kpi_caliber_pending: type: boolean const: false has_prompts: type: boolean has_completed_records: type: 'null' total_mentions: type: 'null' ranked_records: type: 'null' completed_records: type: 'null' share_of_voice: type: 'null' share_of_voice_state: type: 'null' best_platform: type: 'null' worst_platform: type: 'null' platforms: type: 'null' visibility_score: type: 'null' mention_rate_pct: type: 'null' citation_rate_pct: type: 'null' avg_position: type: 'null' top3_rate_pct: type: 'null' required: - kpi_state - window - platform - scope - kpi_caliber - kpi_caliber_pending - has_prompts - has_completed_records - total_mentions - ranked_records - completed_records - share_of_voice - share_of_voice_state - best_platform - worst_platform - platforms - visibility_score - mention_rate_pct - citation_rate_pct - avg_position - top3_rate_pct 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.