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 /me/alerts

Returns recent alerts, newest first. 
curl "https://app.neariq.io/api/v1/me/alerts?limit=50" \
  -H "X-NearIQ-Key: niq_your_key_here"
Query parameters
ParameterTypeDefaultDescription
limitinteger50Alerts per page (max 200)
offsetinteger0Pagination offset
severitystring—Filter: info, warning, opportunity, danger
typestring—Filter by alert type (for example rating_drop, review_surge, price_change, or trend_opportunity)
sinceISO date—Only alerts after this date
{
  "alerts": [
    {
      "id": "alert_abc",
      "type": "rating_drop",
      "severity": "opportunity",
      "competitorId": "comp_xyz",
      "competitorName": "Rival Pizza",
      "diff": -0.3,
      "previousValue": 4.6,
      "currentValue": 4.3,
      "detectedAt": "2026-04-27T08:14:22Z",
      "read": false
    }
  ],
  "total": 14
}