Alerts

Alerts are macroeconomic events and shocks relevant to a given time series, based on daily data. Submit timeseries metadata (title, description, and keywords) and the engine returns the top matching events ordered by relevance, with trend direction, percentage change, and supporting news articles for each one.

For the full request shape and per-field validation, see POST /api/v1/alerts.

Use cases

• Discovering what market factors had unusual dynamics related to your timeseries topic.
• Getting immediate results for a recommendation system or exploratory analysis, without an async job.
• Using news articles to understand why a market factor triggered an alert.
• Scoping the alert universe by region or category.

Pricing

Billing applies only on 2xx. The cost includes a base fee plus scales with the number of alert items the system returns. The cost of the request is shown on the Developers Portal pricing page.

A pre-charge hold is applied assuming the maximum number of alerts that can be returned, which is 100 when no result limit filter is defined. If there is not enough balance to satisfy the pre-charge hold, the operation is blocked.

See also

• API reference: POST /api/v1/alerts.
• Synchronous driver recommendations: Drivers.
• Find valid filter ids: Regions & categories.
• Clients: Using curl · Python SDK · Go SDK.