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.

AI Visibility summarizes how often the active business is mentioned in answer-style search results for local purchase-intent queries. This endpoint is available on Growth and higher plans.

Endpoint

GET /api/businesses/me/ai-visibility?days=30

Query parameters

ParameterTypeNotes
daysnumberOptional. Window size from 7 to 90 days. Defaults to 30.

Response

{
  "connected": true,
  "businessId": "business_123",
  "businessName": "Riverside Fitness",
  "days": 30,
  "score": 42,
  "scoreChange": 8,
  "engines": [
    {
      "engine": "answer_engine",
      "mentioned": 3,
      "total": 5,
      "percentage": 60,
      "averagePosition": 2.3
    }
  ],
  "topQueries": [
    {
      "query": "best gym near downtown Austin",
      "mentioned": true,
      "mentionPosition": 2,
      "competitorsMentioned": ["Metro Strength"],
      "lastChecked": "2026-05-01T00:00:00.000Z"
    }
  ],
  "recommendations": [
    "You are mentioned in 42% of AI visibility checks. Add specific service and location content to improve answer coverage."
  ],
  "lastChecked": "2026-05-01T00:00:00.000Z",
  "recent": []
}

Errors

StatusCodeNotes
401UnauthorizedThe request is not authenticated.
403plan_requiredThe active account is below Growth.
500Failed to load AI visibilityThe visibility summary could not be loaded.

Notes

  • Results are scoped to the authenticated user’s active accessible business.
  • Organization members only receive data for businesses available through their active organization membership.
  • If no business is connected, the response returns connected: false with setup recommendations.