Sign in

v2

latestOpenAPI 3.0.32026-07-26112274.7 KB

Detect anomaly alerts for your timeseries

Finds alerts related to the provided metadata.

This is a synchronous billed endpoint — you are charged per alert returned. No charge is recorded on validation errors or upstream failures.

post/api/v1/alerts

Request body

context_enrichedboolean required

When true, treat the supplied metadata as already context-enriched.

date_fromstring

Optional start date bound for alert detection (YYYY-MM-DD).

date_tostring

Optional end date bound for alert detection (YYYY-MM-DD).

Example request

{
  "context_enriched": true,
  "date_from": "2024-01-01",
  "date_to": "2026-05-26",
  "filters": {
    "categories": [
      3,
      7
    ],
    "regions": [
      42
    ],
    "limit": 10
  },
  "metadata": {
    "description": "Monthly average Brent crude oil spot price in USD/barrel, sourced from EIA.",
    "keywords": [
      "oil",
      "brent",
      "energy",
      "commodity",
      "barrel"
    ],
    "title": "Brent Crude Oil Price Monthly"
  }
}

Response

Alerts detected for your timeseries, ordered by relevance.

Example response

{
  "alerts": [
    {
      "trending": true,
      "name": "OMX Copenhagen Oil, Gas and Coal Price Index",
      "pct_change": -7.14,
      "news": [
        {
          "trending": true,
          "title": "US-Iran agreed on principal deal to open Strait of Hormuz",
          "description": "The US and Iran have reportedly reached a preliminary understanding to reopen the Strait of Hormuz.",
          "url": "https://www.thenews.com.pk/latest/1403722",
          "published_at": "2026-05-24T21:28:00Z",
          "source_name": "The News International",
          "category": "world"
        }
      ]
    }
  ]
}
All 11 operations