Skip to main content
GET
/
gap-analysis
curl "https://app.neariq.io/api/v1/gap-analysis" \
  -H "X-NearIQ-Key: niq_your_key_here"
GET /api/v1/gap-analysis returns metadata and source coverage for the latest cached consultant-style gap analysis for the active business, using data NearIQ already tracks. The public v1 response is limited to raw stored facts and does not return generated analysis text, scores, gaps, strengths, or recommendations. This endpoint is available on Growth plans and higher. Use an API key with the analytics:read scope. The public API is read-only and does not regenerate an analysis. Generate or refresh the cache from the dashboard first, then read it here.
​
X-NearIQ-Key
string
required
Your API key from Settings > API Keys
curl "https://app.neariq.io/api/v1/gap-analysis" \
  -H "X-NearIQ-Key: niq_your_key_here"

​
Response

{
  "connected": true,
  "id": "f2d4b5cc-1c25-4d87-9e8b-72a6579b9641",
  "businessId": "8a18b4f8-7b6a-4b5d-a4cc-0adcbcfcc8e7",
  "stale": false,
  "generatedAt": "2026-05-01T00:00:00.000Z",
  "expiresAt": "2026-05-02T00:00:00.000Z",
  "analysisAvailable": true,
  "sourceSummary": {
    "competitors": 5,
    "snapshots": true,
    "reviews": true,
    "products": true,
    "citations": true,
    "rank": true,
    "aiVisibility": true,
    "listingInsights": true
  }
}

​
Access

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

​
Cache behavior

Gap analysis is cached for 24 hours per business. The public API returns stale: true when the latest cached analysis is past its expiration time.