API reference
Base address https://api.messgeo.com. Download the OpenAPI file.
Account
/v1/meAccount, package, key scopes and limits
/v1/me/creditsCredit balance
/v1/me/usageDaily usage of the account
/v1/me/alert-prefsUpdate Prompt Tracking mail preferences
{
"digest": false,
"dry_run": false
}/v1/me/packagesPackages, which panel and site each one is bound to, free slots
Tools
/v1/toolsList tools with credit cost
/v1/tools/{slug}/runsRun a tool. Needs an Idempotency-Key header, spends credits
{
"url": "https://example.com/",
"dry_run": false
}/v1/runsList runs
/v1/runs/{run_id}Get a run
Premium reports
/v1/ordersList premium report orders
/v1/orders/{order_id}Get an order
/v1/orders/{order_id}/reportDelivered report as HTML
Prompt Tracking: read
/v1/panelsList panels
/v1/panels/{panel_id}Get a panel
/v1/panels/{panel_id}/promptsList prompts
/v1/panels/{panel_id}/prompts/{prompt_id}/resultsPer engine results of one prompt
/v1/panels/{panel_id}/statsVisibility per measurement
/v1/panels/{panel_id}/answersAI answers. Starter gets excerpts in bulk, full text with prompt filter
/v1/panels/{panel_id}/sourcesCited sources
/v1/panels/{panel_id}/competitorsCompetitors
/v1/panels/{panel_id}/opportunitiesSource opportunities
/v1/panels/{panel_id}/alertsAlerts
/v1/panels/{panel_id}/eventsPanel events
/v1/panels/{panel_id}/actionsActions
/v1/panels/{panel_id}/exportCSV export, once per minute per key
/v1/panels/{panel_id}/setupSetup state of a draft panel with prompt candidates
/v1/panels/{panel_id}/prompts/metricsRank, first place rate and sentiment per prompt
/v1/panels/{panel_id}/marketMarket map
/v1/panels/{panel_id}/brandBrand image and site check
/v1/panels/{panel_id}/insightsRecommendation cards and focus prompts
/v1/panels/{panel_id}/enginesFeature rates per engine
/v1/panels/{panel_id}/sources/gapsSources that cite rivals but not you
/v1/panels/{panel_id}/gscSearch Console queries
/v1/panels/{panel_id}/ga4Visits from AI assistants
/v1/panels/{panel_id}/integrationsIntegration status and connect address
/v1/panels/{panel_id}/sharesShare links
Prompt Tracking: write
/v1/panelsCreate a panel on a free Pro package. Returns a draft
{
"brand": "Acme Ltd",
"website": "https://example.com/",
"competitors": [
"Rival One"
],
"country": "pt",
"language": "en",
"dry_run": true
}/v1/panels/{panel_id}Change country, language and engines. Removing an engine deletes its data and needs confirm true
{
"country": "tr",
"language": "tr",
"engines": [
"chatgpt",
"gemini"
],
"confirm": false,
"dry_run": true
}/v1/panels/{panel_id}Delete a panel and its data. Needs confirm true
{
"confirm": true,
"dry_run": true
}/v1/panels/{panel_id}/promptsAdd prompts, at most 20 per call
{
"prompts": [
{
"text": "best ai visibility tools for agencies",
"topic": "tools",
"tags": [
"agency"
],
"category": "compare",
"critical": false
}
],
"dry_run": true
}/v1/panels/{panel_id}/promptsTurn up to 150 prompts on or off
{
"ids": [
"promptid0000"
],
"active": false,
"dry_run": true
}/v1/panels/{panel_id}/competitorsAdd a competitor
{
"name": "Example Ltd",
"domain": "example.com",
"aliases": [
"Example"
],
"dry_run": true
}/v1/panels/{panel_id}/actionsAdd an action from a recommendation card
{
"key": "invisible_prompts",
"status": "todo",
"due": "2026-12-01",
"remind": true
}/v1/panels/{panel_id}/prompts/{prompt_id}Update a prompt. The text cannot change
{
"active": true,
"topic": "tools",
"tags": [
"agency"
],
"category": "buy",
"critical": true
}/v1/panels/{panel_id}/prompts/{prompt_id}Turn a prompt off. History stays
/v1/panels/{panel_id}/competitors/{competitor_id}Remove a competitor. Needs confirm true
{
"confirm": true
}/v1/panels/{panel_id}/aliasesReplace extra brand names, at most 10
{
"aliases": [
"Former Name",
"second-domain.com"
]
}/v1/panels/{panel_id}/actions/{action_id}/doneMark an action done
/v1/panels/{panel_id}/actions/{action_id}/undoRemove an action
/v1/panels/{panel_id}/opportunities/markMark an opportunity
{
"url": "https://forum.example/thread/1",
"state": "added"
}/v1/panels/{panel_id}/setupEdit a draft panel
{
"description": "What the business does.",
"services": [
"Service"
],
"sector": "Software",
"competitors": [
{
"name": "Rival One",
"aliases": [
"Rival"
]
}
],
"aliases": [
"Former Name"
]
}/v1/panels/{panel_id}/sharesCreate a password protected share link
{
"label": "Agency",
"password": "at-least-8-chars",
"sections": [
"kpi",
"rivals"
]
}/v1/panels/{panel_id}/setup/topicsAdd a topic to a draft, generates prompt candidates
{
"topic": "Pricing"
}/v1/panels/{panel_id}/setup/approveActivate the panel and start the first measurement. Needs confirm true
{
"prompt_ids": [
"promptid0000"
],
"critical_ids": [],
"extra": [
"another prompt"
],
"engines": [
"chatgpt"
],
"confirm": true
}/v1/panels/{panel_id}/pausePause measurements
/v1/panels/{panel_id}/resumeResume measurements
/v1/panels/{panel_id}/actions/{action_id}Change the due date
{
"due": "2026-12-15"
}/v1/panels/{panel_id}/market/hideHide or show a name on the market map
{
"name": "Example",
"undo": false
}/v1/panels/{panel_id}/brand/confirmConfirm a site check item
{
"id": "0000000000000000000000000000000000000000"
}/v1/panels/{panel_id}/shares/{share_id}Revoke a share link. Needs confirm true
{
"confirm": true
}/v1/panels/{panel_id}/integrations/{service}/syncRefresh gsc or ga4 data
/v1/panels/{panel_id}/integrations/{service}/disconnectDisconnect gsc or ga4. Needs confirm true
{
"confirm": true
}