Skip to main content
GET
/
me
/
alerts
curl "https://app.neariq.io/api/v1/me/alerts?limit=20&unread=true" \
  -H "X-NearIQ-Key: niq_your_key_here"
Returns recent alerts, newest first.
​
X-NearIQ-Key
string
required
Your API key from Settings > API Keys.
Required scope: alerts:read.

​
GET /api/v1/me/alerts

curl "https://app.neariq.io/api/v1/me/alerts?limit=20&unread=true" \
  -H "X-NearIQ-Key: niq_your_key_here"
Query parameters:
ParameterTypeDefaultDescription
limitinteger50Alerts per page, max 200
unreadbooleanfalseOnly return unread alerts
typestring-Filter by alert type, such as rating_drop, review_surge, price_change, or trend_opportunity
{
  "count": 1,
  "alerts": [
    {
      "id": "94d92b0e-0a92-46bb-86c3-6f8f9d3dafbf",
      "type": "rating_drop",
      "title": "Competitor rating dropped",
      "description": "A tracked competitor rating dropped.",
      "recommendation": "Watch for repeated complaints and adjust your response playbook.",
      "severity": "opportunity",
      "competitorId": "comp_xyz",
      "competitorName": "Rival Pizza",
      "createdAt": "2026-04-27T08:14:22Z",
      "read": false
    }
  ]
}

​
PATCH /api/v1/me/alerts/:id

Marks an alert as read or unread. Required scope: alerts:write. 
curl -X PATCH "https://app.neariq.io/api/v1/me/alerts/94d92b0e-0a92-46bb-86c3-6f8f9d3dafbf" \
  -H "X-NearIQ-Key: niq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "read": true }'

{
  "alert": {
    "id": "94d92b0e-0a92-46bb-86c3-6f8f9d3dafbf",
    "read": true
  }
}