Skip to main content
GET
/
api
/
v1
/
insights
/
alerts
Get View Alerts
curl --request GET \
  --url https://api.openfunnel.dev/api/v1/insights/alerts \
  --header 'X-API-Key: <x-api-key>'
{
  "total_alerts": 0,
  "has_more": false,
  "net_new_account_count": 0,
  "alerts": [
    {
      "alert_id": 123,
      "view_name": "<string>",
      "saved_view_id": "<string>",
      "notification_type": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "subject": "<string>",
      "recipient_email": "<string>",
      "slack_channel_id": "<string>",
      "insight_count": 0,
      "account_count": 0,
      "matched_account_ids": [
        123
      ],
      "insights": [
        {
          "insight_id": 123,
          "account_id": 123,
          "alert_text": "<string>",
          "alert_type": "<string>",
          "account_name": "<string>",
          "account_domain": "<string>",
          "alert_date": "<string>",
          "sentiment": "<string>",
          "is_net_new_account": false
        }
      ]
    }
  ]
}

Headers

​
X-API-Key
string
required

Query Parameters

​
days
integer
default:1

Number of days back to look

Required range: 1 <= x <= 30
​
limit
integer
default:20

Maximum alerts per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of alerts to skip

Required range: x >= 0
​
view_ids
string[] | null

Only return alerts from these saved views (IDs from GET /api/v1/views). Repeat the parameter (?view_ids=a&view_ids=b) or pass a comma-separated list.

Response

Successful Response

Response for get_my_alerts - user's notification history with insights.

​
total_alerts
integer
default:0
​
has_more
boolean
default:false
​
net_new_account_count
integer
default:0

Number of accounts appearing for the first time in this time window

​
alerts
AlertItem · object[]