Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neariq.io/llms.txt

Use this file to discover all available pages before exploring further.

GET /api/v1/ai-visibility returns the active business’s AI answer presence for Growth plans and higher. Use an API key with the competitors:read scope.

​
Query parameters

NameTypeDefaultNotes
daysinteger30Clamped between 7 and 90.

​
Response

{
  "connected": true,
  "businessId": "uuid",
  "businessName": "Riverside Fitness",
  "days": 30,
  "score": 42,
  "scoreChange": 5,
  "engines": {
    "answer_engine": {
      "mentioned": 3,
      "total": 8,
      "percentage": 37,
      "averagePosition": 2.3
    }
  },
  "topQueries": [
    {
      "query": "best gym austin",
      "mentioned": true,
      "engines": ["answer_engine"],
      "position": 2,
      "mentionText": "Riverside Fitness is known for...",
      "competitorsMentioned": ["Example Competitor"],
      "checkedAt": "2026-05-01T00:00:00.000Z"
    }
  ],
  "recommendations": [
    "For queries where you are missing, add concise service-area pages and FAQ schema that directly answer those search phrases."
  ],
  "lastChecked": "2026-05-01T00:00:00.000Z",
  "recent": []
}

​
Access

The endpoint uses the caller’s active personal or organization business context. Organization members can read rows for businesses they can access. Accounts below Growth receive 403. API keys without competitors:read receive 403 requiredScope.