This page explains each backend API area in plain words and marks where to focus first.
Legend
<span class="doc-badge important">High Focus</span>: key product endpoints.<span class="doc-badge secondary">Medium Focus</span>: useful but secondary.<span class="doc-badge muted">Low Focus</span>: internal/specialized.<span class="doc-badge ok">Used</span>: detected in frontend flows.<span class="doc-badge warn">Not Used</span>: not directly detected in frontend flows.<span class="doc-badge ok">Documented</span>: endpoint summary exists.<span class="doc-badge warn">Not Documented</span>: missing clear summary.
settings
What this group does: Workspace settings, keys, webhooks, formulas, and administrative controls.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/api-keys | High Focus | Used System / Cost Management | Documented | List API keys |
POST /api/api-keys | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Create API key |
DELETE /api/api-keys/{key_id} | Medium Focus | Not Used | Documented | Revoke API key |
GET /api/audit-logs | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List audit logs |
GET /api/integrations | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | List integration connections |
POST /api/integrations | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | Create integration connection |
GET /api/integrations/catalog | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | List supported integration providers |
DELETE /api/integrations/{integration_id} | Medium Focus | Not Used | Documented | Delete integration connection |
POST /api/integrations/{integration_id}/test | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Test integration connectivity |
GET /api/settings | Medium Focus | Not Used | Documented | Get workspace settings |
PUT /api/settings | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Update workspace settings |
GET /api/settings/export | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Export workspace data snapshot |
GET /api/settings/metric-formulas | High Focus | Used System / Metric Formulas | Documented | List all metric formulas and explanations |
PUT /api/settings/metric-formulas/{metric_key} | High Focus | Used System / Metric Formulas | Documented | Update or reset a metric formula override |
POST /api/settings/request-account-deletion | Medium Focus | Not Used | Documented | Create account deletion request |
GET /api/settings/support-ticket-instructions | Medium Focus | Not Used | Documented | Get support ticket instructions |
GET /api/settings/support-tickets | Medium Focus | Not Used | Documented | List support tickets |
POST /api/settings/support-tickets | Medium Focus | Not Used | Documented | Create support ticket |
GET /api/support/ticket-instructions | High Focus | Used System / Support | Documented | Get support ticket instructions |
GET /api/support/tickets | High Focus | Used System / Support | Documented | List support tickets |
POST /api/support/tickets | High Focus | Used System / Support | Documented | Create support ticket |
GET /api/webhooks | Medium Focus | Not Used | Documented | List webhook endpoints |
POST /api/webhooks | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Create webhook endpoint |
DELETE /api/webhooks/{webhook_id} | Medium Focus | Not Used | Documented | Delete webhook endpoint |
PATCH /api/webhooks/{webhook_id}/toggle | Medium Focus | Not Used | Documented | Toggle webhook active state |
analytics-insights
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/analytics/citations/categories | Medium Focus | Not Used | Documented | Citation Categories |
GET /api/analytics/citations/graph | Medium Focus | Indirect frontend/src/components/insights/CitationsTab.tsx | Documented | Citation Graph |
GET /api/analytics/citations/watched-pages | Medium Focus | Not Used | Documented | List Watched Pages |
POST /api/analytics/citations/watched-pages | Medium Focus | Not Used | Documented | Add Watched Page |
DELETE /api/analytics/citations/watched-pages/{page_id} | Medium Focus | Not Used | Documented | Remove Watched Page |
GET /api/analytics/extraction-quality/latest | High Focus | Used System / Cost Management | Documented | Extraction Quality Latest |
GET /api/analytics/network/distribution | High Focus | Used System / Cost Management | Documented | Network Distribution |
GET /api/analytics/network/latency | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Network Latency |
GET /api/analytics/platforms | Medium Focus | Indirect frontend/src/components/insights/PlatformsTab.tsx, frontend/src/components/insights/VisibilityTab.tsx | Documented | Platform Breakdown |
GET /api/analytics/platforms/analysis | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Platform Analysis |
GET /api/analytics/query-fanouts | Medium Focus | Not Used | Documented | Query Fanouts |
GET /api/analytics/query-fanouts/analyze | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Query Fanout Analyze |
GET /api/analytics/regions | Medium Focus | Not Used | Documented | Region Breakdown |
GET /api/analytics/scrape-quality/latest | Medium Focus | Not Used | Documented | Latest Scrape Quality |
GET /api/analytics/sentiment | Medium Focus | Not Used | Documented | Sentiment Analysis |
POST /api/analytics/sentiment/generate | Medium Focus | Not Used | Documented | Generate Sentiment |
GET /api/analytics/sentiment/status | Medium Focus | Not Used | Documented | Sentiment Status |
GET /api/analytics/share-of-voice | Medium Focus | Not Used | Documented | Share Of Voice |
GET /api/analytics/topic-performance | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Topic Performance |
GET /api/analytics/visibility-settings | Medium Focus | Not Used | Documented | Get Visibility Settings |
PUT /api/analytics/visibility-settings | Medium Focus | Not Used | Documented | Update Visibility Settings |
GET /api/analytics/visibility/drilldown | Medium Focus | Indirect frontend/src/components/insights/VisibilityTab.tsx | Documented | Visibility Drilldown |
agent-analytics
What this group does: Crawler, referral, and worker telemetry for agent traffic intelligence.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/agent-analytics/bots | High Focus | Used /agent-analytics, /website/:domain (+7) | Documented | List Bot Visits |
POST /api/agent-analytics/cloudflare/enroll | High Focus | Used /agent-analytics, /website/:domain (+7) | Documented | Enroll Cloudflare Worker |
POST /api/agent-analytics/cloudflare/logs | Medium Focus | Not Used | Documented | Ingest Cloudflare Worker Logs |
POST /api/agent-analytics/cloudflare/network/configure | Medium Focus | Not Used | Documented | Configure Cloudflare Network |
POST /api/agent-analytics/cloudflare/network/profile/select | Medium Focus | Not Used | Documented | Select Cloudflare Network Profile |
GET /api/agent-analytics/cloudflare/network/profiles | Medium Focus | Not Used | Documented | Cloudflare Network Profiles |
GET /api/agent-analytics/cloudflare/network/status | High Focus | Used /agent-analytics, /website/:domain (+7) | Documented | Cloudflare Network Status |
GET /api/agent-analytics/cloudflare/status | High Focus | Used /agent-analytics, /website/:domain (+7) | Documented | Cloudflare Worker Status |
GET /api/agent-analytics/heatmap | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Heatmap Report |
POST /api/agent-analytics/ingest | Medium Focus | Not Used | Documented | Ingest Logs |
GET /api/agent-analytics/overview | Medium Focus | Not Used | Documented | Overview |
GET /api/agent-analytics/pages | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Pages Report |
GET /api/agent-analytics/pages/detail | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Pages Detail Report |
GET /api/agent-analytics/pages/index | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Pages Index Report |
GET /api/agent-analytics/referrals | High Focus | Used /agent-analytics, /website/:domain (+7) | Documented | List Referral Visits |
GET /api/agent-analytics/reports/bots | Medium Focus | Not Used | Documented | Report Bots Daily |
GET /api/agent-analytics/reports/referrals | Medium Focus | Not Used | Documented | Report Referrals Daily |
GET /api/agent-analytics/xyops/status | High Focus | Used System / Cost Management | Documented | Xyops Status |
prompt-management
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/prompt-templates | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List prompt templates |
POST /api/prompt-templates | High Focus | Used /brand/topics, /prompt-management | Documented | Create prompt template |
DELETE /api/prompt-templates/{template_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Delete prompt template |
PUT /api/prompt-templates/{template_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Update prompt template |
POST /api/prompt-templates/{template_id}/accept | High Focus | Used /brand/topics, /prompt-management | Documented | Accept suggested template |
POST /api/prompt-templates/{template_id}/reject | High Focus | Used /brand/topics, /prompt-management | Documented | Reject and delete suggested template |
POST /api/prompts/batch | Low Focus | Not Used | Documented | Batch action on templates |
POST /api/prompts/estimate-volume | Low Focus | Not Used | Documented | Estimate search volume |
POST /api/prompts/suggest | Low Focus | Not Used | Documented | AI-powered prompt suggestions |
POST /api/prompts/upload-csv | Low Focus | Not Used | Documented | Upload CSV of prompts |
GET /api/tags | Low Focus | Indirect frontend/src/components/filters/DashboardFilters.tsx | Documented | List tags for org |
POST /api/tags | High Focus | Used /brand/topics, /prompt-management | Documented | Create tag |
DELETE /api/tags/{tag_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Delete tag |
PUT /api/tags/{tag_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Update tag name |
GET /api/topics | Low Focus | Indirect frontend/src/components/filters/DashboardFilters.tsx | Documented | List topics for org |
POST /api/topics | High Focus | Used /brand/topics, /prompt-management | Documented | Create topic |
DELETE /api/topics/{topic_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Delete topic |
PUT /api/topics/{topic_id} | High Focus | Used /brand/topics, /prompt-management | Documented | Update topic name |
analytics
What this group does: Visibility, sentiment, platform, and citation analytics powering dashboard insights.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/active-sessions | Medium Focus | Not Used | Documented | Get active scraping sessions |
GET /api/citations | Medium Focus | Not Used | Documented | Get citation statistics |
GET /api/citations/mismatches | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get mismatch alerts |
GET /api/compare | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Compare two periods |
GET /api/cost-estimate | Medium Focus | Not Used | Documented | Estimate daily costs |
PUT /api/daily-quota | Medium Focus | Not Used | Documented | Update daily quota |
GET /api/daily-stats | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | Get daily statistics |
GET /api/export/citations.csv | Medium Focus | Indirect frontend/src/components/insights/CitationsTab.tsx | Documented | Export citations domain breakdown as CSV |
GET /api/export/{section}.csv | Medium Focus | Not Used | Documented | Export analytics section as CSV |
GET /api/job-history | Medium Focus | Not Used | Documented | Get job execution history |
GET /api/metrics | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get dashboard metrics |
GET /api/suggestions | Medium Focus | Not Used | Documented | Get SEO suggestions |
GET /api/visibility | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get visibility data |
onboarding
What this group does: First-run workspace setup and setup-assist automation.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/onboarding/account-type | Low Focus | Not Used | Documented | Save Account Type |
POST /api/onboarding/admin/account-status | Low Focus | Not Used | Documented | Admin Onboarding Account Status |
POST /api/onboarding/admin/sync-account | Low Focus | Not Used | Documented | Admin Onboarding Sync Account |
POST /api/onboarding/admin/unlock-account | Low Focus | Not Used | Documented | Admin Onboarding Unlock Account |
POST /api/onboarding/agency-waitlist | Low Focus | Not Used | Documented | Join Agency Waitlist |
POST /api/onboarding/complete | Low Focus | Not Used | Documented | Complete Onboarding |
POST /api/onboarding/discover-competitors | Low Focus | Not Used | Documented | Discover Competitors |
POST /api/onboarding/generate-prompts | High Focus | Used /onboarding, Onboarding / Getting Started | Documented | Generate Ai Prompts |
GET /api/onboarding/prompts | High Focus | Used /onboarding, Onboarding / Getting Started | Documented | Get Prompts For Review |
POST /api/onboarding/prompts | Low Focus | Not Used | Documented | Save Prompts |
GET /api/onboarding/status | High Focus | Used /onboarding, Onboarding / Getting Started | Documented | Get Onboarding Status |
GET /api/onboarding/topics | High Focus | Used /onboarding, Onboarding / Getting Started | Documented | Get Available Topics |
POST /api/onboarding/topics | Low Focus | Not Used | Documented | Save Topics |
content-cms
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/content-cms/articles | Low Focus | Not Used | Documented | List Articles |
POST /api/content-cms/articles | Low Focus | Not Used | Documented | Create Article |
DELETE /api/content-cms/articles/{article_id} | Low Focus | Not Used | Documented | Delete Article |
GET /api/content-cms/articles/{article_id} | Low Focus | Not Used | Documented | Get Article |
PUT /api/content-cms/articles/{article_id} | Low Focus | Not Used | Documented | Update Article |
POST /api/content-cms/articles/{article_id}/generate-draft | Low Focus | Not Used | Documented | Generate Draft |
GET /api/content-cms/articles/{article_id}/workflow-status | Low Focus | Not Used | Documented | Get Workflow Status |
GET /api/content-cms/connectors/status | Low Focus | Not Used | Documented | Connectors Status |
POST /api/content-cms/generate-brief | Low Focus | Not Used | Documented | Generate Brief |
POST /api/content-cms/publish | Low Focus | Not Used | Documented | Publish Article |
GET /api/content-cms/publish/targets | Low Focus | Not Used | Documented | List Publish Targets |
GET /api/content-cms/templates | Low Focus | Not Used | Documented | List Templates |
actions
What this group does: Action lifecycle management, recommendation execution, and planning workflows.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/actions | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List Actions |
POST /api/actions | High Focus | Used Actions / Actions | Documented | Create Action |
POST /api/actions/generate | Low Focus | Not Used | Documented | Generate Actions |
GET /api/actions/timeline | Low Focus | Not Used | Documented | Get Timeline |
DELETE /api/actions/{action_id} | High Focus | Used Actions / Actions | Documented | Delete Action |
PUT /api/actions/{action_id} | Low Focus | Not Used | Documented | Update Action |
POST /api/actions/{action_id}/complete | Low Focus | Not Used | Documented | Complete Action |
POST /api/actions/{action_id}/plan | Low Focus | Not Used | Documented | Add To Plan |
POST /api/actions/{action_id}/postpone | Low Focus | Not Used | Documented | Postpone Action |
POST /api/actions/{action_id}/start | Low Focus | Not Used | Documented | Start Action |
POST /api/actions/{action_id}/verify | Low Focus | Not Used | Documented | Verify Action |
brands
What this group does: Brand entities, destinations, and brand-level visibility configuration.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/brands | High Focus | Used Actions / Suggestions | Documented | List all brands |
POST /api/brands | High Focus | Used /brand/competitors, /brand/domains (+3) | Documented | Create a new brand |
GET /api/brands/details | Medium Focus | Not Used | Documented | Get detailed brand analytics |
GET /api/brands/suggested | Medium Focus | Not Used | Documented | Get suggested brands from recent chats |
DELETE /api/brands/{brand_id} | Medium Focus | Not Used | Documented | Delete a brand |
PATCH /api/brands/{brand_id} | High Focus | Used /brand/competitors, /brand/domains (+3) | Documented | Update brand advanced settings |
GET /api/brands/{brand_id}/domains | Medium Focus | Not Used | Documented | Get domains for a brand |
POST /api/brands/{brand_id}/domains | Medium Focus | Not Used | Documented | Add domain to a brand |
DELETE /api/brands/{brand_id}/domains/{domain_id} | Medium Focus | Not Used | Documented | Remove domain from a brand |
GET /api/brands/{brand_id}/link-destinations | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get link destinations for a brand |
PUT /api/brands/{brand_id}/set-primary | Medium Focus | Not Used | Documented | Set a brand as primary |
knowledge-bases
What this group does: Knowledge source management for retrieval and AI grounding.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/knowledge-bases | Low Focus | Not Used | Documented | List Knowledge Bases |
POST /api/knowledge-bases | High Focus | Used Context / Knowledge Bases | Documented | Create Knowledge Base |
GET /api/knowledge-bases/status | Low Focus | Not Used | Documented | Knowledge Base Status |
DELETE /api/knowledge-bases/{kb_id} | Low Focus | Not Used | Documented | Delete Knowledge Base |
PATCH /api/knowledge-bases/{kb_id} | Low Focus | Not Used | Documented | Update Knowledge Base |
GET /api/knowledge-bases/{kb_id}/documents | Low Focus | Not Used | Documented | List Documents |
DELETE /api/knowledge-bases/{kb_id}/documents/{document_id} | Low Focus | Not Used | Documented | Delete Document |
POST /api/knowledge-bases/{kb_id}/documents/{document_id}/reindex | Low Focus | Not Used | Documented | Reindex Document |
POST /api/knowledge-bases/{kb_id}/import-url | Low Focus | Not Used | Documented | Import Url |
POST /api/knowledge-bases/{kb_id}/search | Low Focus | Not Used | Documented | Search Knowledge Base |
POST /api/knowledge-bases/{kb_id}/upload | Low Focus | Not Used | Documented | Upload Document |
jobs
What this group does: Scrape and processing job scheduling, status, and execution details.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/jobs | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | List scraping jobs |
POST /api/jobs/scrape | Medium Focus | Not Used | Documented | Create scraping job |
GET /api/jobs/{job_id} | Medium Focus | Not Used | Documented | Get job details |
GET /api/jobs/{job_id}/details | High Focus | Used System / Cost Management | Documented | Get detailed job information |
GET /api/jobs/{job_id}/html | Medium Focus | Not Used | Documented | Get job HTML snapshot |
GET /api/scheduled-jobs | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | List scheduled/recurring jobs |
DELETE /api/scheduled-jobs/{job_id} | Medium Focus | Not Used | Documented | Delete a scheduled job |
GET /api/scheduled-jobs/{job_id} | Medium Focus | Not Used | Documented | Get scheduled job details |
PUT /api/scheduled-jobs/{job_id}/pause | Medium Focus | Not Used | Documented | Pause a scheduled job |
PUT /api/scheduled-jobs/{job_id}/resume | Medium Focus | Not Used | Documented | Resume a paused job |
system
What this group does: Platform health, admin tooling, and system-level operations.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/admin/docs | Low Focus | Not Used | Documented | Admin Dashboard Documentation |
GET /api/config | Low Focus | Not Used | Documented | Get system configuration |
GET /api/docker/containers | Low Focus | Not Used | Documented | List Docker containers |
GET /api/docker/logs/{container} | Low Focus | Not Used | Documented | Get Docker container logs |
GET /api/proxy-providers | Low Focus | Not Used | Documented | List all proxy providers and their status |
GET /api/scheduler-status | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Get scheduler status |
GET /api/screenshots | Low Focus | Not Used | Documented | List all screenshots |
GET /api/screenshots/{filename} | Low Focus | Not Used | Documented | Get screenshot image |
GET /api/stats/database | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Get database statistics |
GET /api/vpn/servers | Low Focus | Not Used | Documented | Get VPN servers |
customer-api
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /v1/brands | Low Focus | Not Used | Documented | List Brands |
GET /v1/chats | Low Focus | Not Used | Documented | List Chats |
GET /v1/chats/{chat_id} | Low Focus | Not Used | Documented | Get Chat Detail |
GET /v1/models | Low Focus | Not Used | Documented | List Models |
GET /v1/prompts | Low Focus | Not Used | Documented | List Prompts |
POST /v1/reports/brands | Low Focus | Not Used | Documented | Report Brands |
POST /v1/reports/domains | Low Focus | Not Used | Documented | Report Domains |
GET /v1/tags | Low Focus | Not Used | Documented | List Tags |
GET /v1/topics | Low Focus | Not Used | Documented | List Topics |
google-analytics
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/settings/ga/connect | Low Focus | Not Used | Documented | Connect Ga |
POST /api/settings/ga/deep-analysis | Low Focus | Not Used | Documented | Trigger Deep Analysis |
POST /api/settings/ga/disconnect | Low Focus | Not Used | Documented | Disconnect Ga |
GET /api/settings/ga/oauth/callback | Low Focus | Not Used | Documented | Oauth Callback |
POST /api/settings/ga/oauth/connect | Low Focus | Not Used | Documented | Oauth Connect |
GET /api/settings/ga/oauth/properties | Low Focus | Not Used | Documented | Oauth Properties |
POST /api/settings/ga/oauth/start | Low Focus | Not Used | Documented | Oauth Start |
GET /api/settings/ga/status | High Focus | Used /agent-analytics, /brand/settings (+16) | Documented | Ga Status |
GET /api/settings/ga/summary | Low Focus | Not Used | Documented | Ga Summary |
billing
What this group does: Plan, subscription, and account monetization management workflows.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/billing/admin/account-status | Medium Focus | Not Used | Documented | Admin Billing Account Status |
POST /api/billing/admin/unlock-account | Medium Focus | Not Used | Documented | Admin Unlock Account Billing |
POST /api/billing/change-plan | High Focus | Used System / Cost Management | Documented | Change Plan |
POST /api/billing/create-checkout-session | High Focus | Used System / Cost Management | Documented | Create Checkout Session |
POST /api/billing/create-portal-session | Medium Focus | Not Used | Documented | Create Portal Session |
GET /api/billing/plans | Medium Focus | Not Used | Documented | List Plans |
GET /api/billing/status | High Focus | Used /brand/settings, /settings/account/api-keys (+8) | Documented | Get Billing Status |
dashboard-filters
What this group does: Dashboard-level filters, dimensions, and default saved views.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/countries | Low Focus | Not Used | Documented | List Countries |
GET /api/models | Low Focus | Not Used | Documented | List Ai Models |
GET /api/personas | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | List Personas |
POST /api/personas | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Create Persona |
DELETE /api/personas/{persona_id} | High Focus | Used /brand/settings, /settings/account/api-keys (+7) | Documented | Delete Persona |
GET /api/personas/{persona_id} | Low Focus | Not Used | Documented | Get Persona |
PUT /api/personas/{persona_id} | Low Focus | Indirect frontend/src/components/insights/PersonasTab.tsx | Documented | Update Persona |
geo
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/geo/competitor-gaps | Low Focus | Not Used | Documented | Generate Competitor Gaps |
POST /api/geo/content-opportunities | Low Focus | Not Used | Documented | Generate Content Opportunities |
POST /api/geo/outreach-targets | Low Focus | Not Used | Documented | Generate Outreach Targets |
POST /api/geo/quick-wins | Low Focus | Not Used | Documented | Generate Quick Wins |
POST /api/geo/strategic-summary | Low Focus | Not Used | Documented | Generate Strategic Summary |
POST /api/geo/technical-checklist | Low Focus | Not Used | Documented | Generate Technical Checklist |
scheduling
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/schedule-batch | Medium Focus | Not Used | Documented | Schedule batch of prompts |
GET /api/templates | Medium Focus | Not Used | Documented | List prompt templates |
POST /api/templates | Medium Focus | Not Used | Documented | Create prompt template |
DELETE /api/templates/{template_id} | Medium Focus | Not Used | Documented | Delete template |
GET /api/templates/{template_id} | Medium Focus | Not Used | Documented | Get template by ID |
PUT /api/templates/{template_id} | Medium Focus | Not Used | Documented | Update template |
agents
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/agents/providers/status | Low Focus | Not Used | Documented | Get Agent Provider Status |
GET /api/agents/runs | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List Agent Runs |
POST /api/agents/runs | High Focus | Used /agents/new, /agents/scheduled (+2) | Documented | Create Agent Run |
GET /api/agents/runs/{run_id} | Low Focus | Not Used | Documented | Get Agent Run |
GET /api/agents/templates | Low Focus | Not Used | Documented | List Agent Templates |
annotations
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/annotations | Low Focus | Not Used | Documented | List Annotations |
POST /api/annotations | Low Focus | Not Used | Documented | Create Annotation |
DELETE /api/annotations/{annotation_id} | Low Focus | Not Used | Documented | Delete Annotation |
GET /api/annotations/{annotation_id} | Low Focus | Not Used | Documented | Get Annotation |
PUT /api/annotations/{annotation_id} | Low Focus | Not Used | Documented | Update Annotation |
benchmark
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/benchmark/leaderboard | Low Focus | Not Used | Documented | Provider leaderboard |
POST /api/benchmark/run | Low Focus | Not Used | Documented | Start a benchmark run |
GET /api/benchmark/runs | Low Focus | Not Used | Documented | List benchmark runs |
GET /api/benchmark/runs/{run_id} | Low Focus | Not Used | Documented | Get benchmark run details |
content-optimization
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/content/analyze | High Focus | Used /content-library/tools/url-slug-optimizer, /content-optimization | Documented | Analyze Content |
GET /api/content/optimizations | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List Optimizations |
DELETE /api/content/optimizations/{optimization_id} | High Focus | Used /content-library/tools/url-slug-optimizer, /content-optimization | Documented | Delete Optimization |
GET /api/content/optimizations/{optimization_id} | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get Optimization Detail |
prompts
What this group does: Prompt catalog, analytics, history, and prompt-level result drilldowns.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/prompts | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List all prompts |
GET /api/prompts/{query_id} | Medium Focus | Indirect frontend/src/hooks/useApi.ts, frontend/src/hooks/useApi.ts | Documented | Get prompt details |
GET /api/prompts/{query_id}/analysis | Medium Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get full prompt analysis |
GET /api/prompts/{query_id}/history | High Focus | Used /brand/prompts, /prompt-editor (+2) | Documented | Get prompt history (audit trail) |
source-analysis
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/sources/classify | Low Focus | Not Used | Documented | Classify Sources |
GET /api/sources/domains | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get Domain Analytics |
GET /api/sources/gap-analysis | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get Gap Analysis |
GET /api/sources/urls | High Focus | Used Analytics / Sources | Documented | Get Url Analytics |
xyops
What this group does: Automation control-plane orchestration and scheduled background workflows.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/xyops/control/dispatch-due | Low Focus | Not Used | Documented | Dispatch due recurring jobs (xyOps controlled) |
POST /api/xyops/control/run-job/{job_id} | Low Focus | Not Used | Documented | Run a specific job/template (xyOps controlled) |
GET /api/xyops/control/status | Low Focus | Not Used | Documented | Get xyOps control-plane status |
GET /api/xyops/control/templates | Low Focus | Not Used | Documented | Get production xyOps event templates |
admin
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/admin/assign-brands-to-org | Low Focus | Not Used | Documented | Assign brands to an organization by clerk org ID |
POST /api/admin/assign-templates-to-org | Low Focus | Not Used | Documented | Assign templates to an organization by clerk org ID |
POST /api/admin/import | Low Focus | Not Used | Documented | Bulk import scraped results |
auth
What this group does: Authentication provider status, identity context, and access control endpoints.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/auth/me | Low Focus | Not Used | Documented | Get current user info |
GET /api/auth/provider/status | Low Focus | Not Used | Documented | Get auth provider readiness |
POST /api/auth/provider/switch | Low Focus | Not Used | Documented | Switch active auth provider at runtime |
recommendations
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/geo/recommendations | Low Focus | Indirect frontend/src/components/geo/KanbanBoard.tsx | Documented | Generate Recommendations Endpoint |
GET /api/geo/recommendations/{brand_id} | Low Focus | Indirect frontend/src/components/geo/KanbanBoard.tsx | Documented | Get Recommendations Endpoint |
PATCH /api/geo/recommendations/{recommendation_id}/status | Low Focus | Not Used | Documented | Update Recommendation Status |
suggestions
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/suggestions/generate | Low Focus | Not Used | Documented | Generate Ai Suggestions |
POST /api/suggestions/generate/v2 | Low Focus | Not Used | Documented | Generate Ai Suggestions V2 |
GET /api/suggestions/status | Low Focus | Not Used | Documented | Get Suggestions Status |
vpn
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/vpn/ip/{country} | Low Focus | Not Used | Documented | Get VPN container IP |
POST /api/vpn/rotate/{country} | Low Focus | Not Used | Documented | Rotate VPN IP |
GET /api/vpn/status | Low Focus | Not Used | Documented | Get all VPN status |
chats
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/chats | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | List Chats |
GET /api/chats/{chat_id} | Low Focus | Indirect frontend/src/hooks/useApi.ts | Documented | Get Chat Detail |
sources
What this group does: Source URLs, domains, gaps, and citation evidence inventories.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/sources | Medium Focus | Not Used | Documented | List all sources |
GET /api/sources/analytics | Medium Focus | Not Used | Documented | Get source analytics |
webhooks
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/webhooks/clerk | Low Focus | Not Used | Documented | Handle Clerk Webhook |
POST /api/webhooks/stripe | Low Focus | Not Used | Documented | Handle Stripe Webhook |
documentation
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/reference | Low Focus | Not Used | Documented | API Reference |
embeddings
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
POST /api/embeddings/sync | Low Focus | Not Used | Documented | Sync Embeddings |
health
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/health | Low Focus | Not Used | Documented | Health check |
prompt-volumes
What this group does: Specialized or uncategorized endpoints with limited surface area.
| Endpoint | Focus | Usage | Documentation | What It Does (Plain Words) |
|---|---|---|---|---|
GET /api/prompt-volumes | High Focus | Used /brand, Analytics / Answer Engine Insights | Documented | Get Prompt Volumes |