geo API

geo endpoints

When To Use This API

The geo API is for agent workflows that need public, platform-native data without writing a custom collector for every task. Use it when a prompt needs evidence from live social records, when a Skill needs repeatable enrichment, or when product code needs the same contract an agent discovered through MCP.

This section lists 7 live geo operations from the canonical OpenAPI spec. Each operation page documents the route, method, parameters, response envelope, pagination behavior when available, and the error vocabulary shared across UnifAPI.

• Use geo operations when an agent needs public records from this platform.
• Call the documented endpoints through MCP or HTTP and keep the response envelope consistent.
• Combine these records with other UnifAPI APIs for research, monitoring, and enrichment workflows.

Agent Contract Notes

Agents usually discover these endpoints with the hosted UnifAPI MCP server, inspect the operation schema, then call only the records needed for the current task. Developers can call the same endpoints over HTTP with an API key, which makes the path from exploratory agent run to production integration direct.

Every successful response uses a stable envelope with a request id, data payload, optional pagination cursor, and billing metadata. Errors use the same closed vocabulary across platforms, so retry logic, user-facing explanations, and cost reporting can stay consistent even when a workflow spans multiple public-data sources.

When you are choosing an operation, start from the public identifier the user already has: a profile username, post id, channel id, subreddit name, search term, or URL-derived slug. Prefer the narrowest endpoint that answers the question, then expand only when the agent needs more evidence. This keeps record usage predictable, makes citations easier to explain, and avoids turning a focused research task into an expensive crawl.

Operations

Keywords

• POST /geo/keywords/search-volume — Get AI search volume for keywords — Look up generative-AI search volume and monthly trend for up to 1000 keywords in a location and language.

Mentions

• POST /geo/mentions/aggregated-metrics — Aggregate LLM mention metrics by dimension — Aggregate LLM mentions of a domain or keyword across platform, location, language, source/search-result domains, and brand entities.
• POST /geo/mentions/cross-aggregated-metrics — Compare LLM mentions across labeled groups — Aggregate and compare LLM mention metrics across several labeled target groups for side-by-side share-of-voice analysis.
• POST /geo/mentions/search — Search LLM mentions of a domain or keyword — Find where a domain or keyword is mentioned across ChatGPT and AI search answers, with the question, answer, cited sources, and AI search volume.
• POST /geo/mentions/top-domains — List domains most cited in LLM answers — Rank the domains most frequently cited as sources in LLM answers for a target domain or keyword, with per-dimension breakdowns.
• POST /geo/mentions/top-pages — List pages most cited in LLM answers — Rank the pages most frequently cited as sources in LLM answers for a target domain or keyword, with per-dimension breakdowns.

Serp

• POST /geo/serp — Search AI Mode generative results — Run one live AI Mode search for generative answer evidence, cited sources, and target-domain visibility.