Skip to main content
GET
/
api
/
alerts
[
  {
    "id": "alt_abc123",
    "name": "CPIX Below 50",
    "type": "cpix_threshold",
    "condition": "below",
    "threshold": 50,
    "active": true,
    "email": "analyst@example.com"
  }
]

Authentication

Requires an alert token in the X-Alert-Token header. Obtain a token via the Get Alert Token endpoint.
X-Alert-Token: <your-alert-token>

Query Parameters

email
string
required
The email address whose alerts to retrieve.

Response

Returns an array of alert objects.
id
string
Unique alert identifier.
name
string
Human-readable alert name.
type
string
Alert type (e.g., cpix_threshold, weekly_digest).
condition
string
Trigger condition.
active
boolean
Whether the alert is currently active.
email
string
Email address receiving notifications.
cURL
curl "https://api.consumersignals.io/api/alerts?email=analyst@example.com" \
  -H "X-Alert-Token: YOUR_ALERT_TOKEN"
Python
import requests

response = requests.get(
    "https://api.consumersignals.io/api/alerts",
    params={"email": "analyst@example.com"},
    headers={"X-Alert-Token": "YOUR_ALERT_TOKEN"}
)
alerts = response.json()
TypeScript
const response = await fetch(
  "https://api.consumersignals.io/api/alerts?email=analyst@example.com",
  {
    headers: {
      "X-Alert-Token": "YOUR_ALERT_TOKEN",
    },
  }
);
const alerts = await response.json();
[
  {
    "id": "alt_abc123",
    "name": "CPIX Below 50",
    "type": "cpix_threshold",
    "condition": "below",
    "threshold": 50,
    "active": true,
    "email": "analyst@example.com"
  }
]