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.

Behavioral Signals compares the active business’s engagement health with tracked competitors. It highlights review replies, response time, review velocity, listing photos, post activity, and review recency. This endpoint is available on Growth and higher plans.

​
Endpoint

GET /api/businesses/me/behavioral-signals

​
Response

{
  "connected": true,
  "businessId": "business_123",
  "businessName": "Riverside Fitness",
  "overallGrade": "C",
  "overallScore": 58,
  "signals": {
    "reviewResponseRate": {
      "value": 45,
      "displayValue": "45%",
      "unit": "%",
      "benchmark": 72,
      "benchmarkDisplay": "72%",
      "percentile": 25,
      "trend": "stable",
      "grade": "D",
      "score": 25,
      "higherIsBetter": true
    }
  },
  "competitorComparison": [
    { "id": "business_123", "name": "Riverside Fitness", "isYou": true, "score": 58, "grade": "C" },
    { "id": "competitor_123", "name": "Metro Strength", "isYou": false, "score": 72, "grade": "B" }
  ],
  "recommendations": [
    {
      "priority": 1,
      "action": "Reply to 12 unanswered reviews",
      "impact": "high",
      "effort": "36 minutes",
      "detail": "You are at 45%; the tracked competitor benchmark is 72%."
    }
  ],
  "dataCoverage": {
    "competitors": 4,
    "reviews": true,
    "snapshots": true,
    "listing": true,
    "posts": false
  }
}

​
Signals

SignalMeaning
reviewResponseRatePercent of visible reviews with an owner reply.
reviewResponseTimeAverage time between review publication and owner reply when exact timestamps are available.
reviewVelocityEstimated new reviews per month from snapshots or cached review dates.
photoCountListing photo count when available.
postFrequencyMonthly listing post activity when collected.
reviewRecencyDays since the newest visible review. Lower is better.

​
Errors

StatusCodeNotes
401UnauthorizedThe request is not authenticated.
403plan_requiredThe active account is below Growth.
500Failed to load behavioral signalsThe signal 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.
  • When a signal does not have enough source data, displayValue returns a clear unavailable state and the signal is excluded from scoring.