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/gbp-insights Returns synced Google Business Profile performance metrics for the API key owner’s active business. Use an API key with the competitors:read scope. 
curl "https://app.neariq.io/api/v1/gbp-insights?days=30" \
  -H "X-NearIQ-Key: niq_live_..."
Query parameters:
ParameterTypeRequiredNotes
daysnumbernoDefaults to 30. Minimum 7, maximum 90.
{
  "connected": true,
  "businessId": "8a18b4f8-7b6a-4b5d-a4cc-0adcbcfcc8e7",
  "locationTitle": "Riverside Fitness",
  "locationName": "locations/123456789",
  "lastFetchedAt": "2026-04-29T18:00:00.000Z",
  "days": 30,
  "totals": {
    "BUSINESS_IMPRESSIONS_MOBILE_SEARCH": 1200,
    "BUSINESS_DIRECTION_REQUESTS": 83,
    "CALL_CLICKS": 19,
    "WEBSITE_CLICKS": 42
  },
  "series": {
    "WEBSITE_CLICKS": [
      { "date": "2026-04-01", "value": 3 }
    ]
  },
  "keywords": [
    { "keyword": "gym near me", "impressions": 120, "date": "2026-03-01" }
  ],
  "insights": []
}

​
Metrics

The background worker syncs connected profiles daily. Metrics can include Search and Maps impressions, direction requests, call clicks, website clicks, and message conversations. Search keywords are returned separately in keywords. If connected is false, the user has not connected a Google Business Profile for the active business yet. Accounts below Growth receive 403. API keys without competitors:read receive 403 requiredScope.