Skip to main content
GET
/
api
/
weekly-digest
Weekly Digest
curl --request GET \
  --url https://api.example.com/api/weekly-digest
{
  "generatedAt": "<string>",
  "digest": {
    "recentAlerts": [
      {}
    ],
    "primaryRegime": "<string>",
    "regimeChanges": 123,
    "dominantReasons": [
      {}
    ],
    "weekOverWeekDelta": {}
  },
  "alertCount": 123,
  "deliveryCount": 123
}

​
Endpoint

GET /api/weekly-digest
Returns a weekly digest of market regime activity, summarizing recent alerts and their implications. The digest aggregates regime alerts from the past week to identify trends and patterns.

​
Response

​
generatedAt
string
required
ISO 8601 timestamp when the digest was generated
​
digest
object
required
Processed weekly digest data
​
alertCount
number
required
Total number of regime alerts in storage
​
deliveryCount
number
required
Number of alert deliveries that have been sent

​
Example Request

curl https://your-domain.com/api/weekly-digest

​
Example Response

{
  "generatedAt": "2026-03-03T10:00:00Z",
  "digest": {
    "recentAlerts": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "createdAt": "2026-03-03T09:15:00Z",
        "payload": {
          "reason": "CURVE_INVERSION_DEEPENED",
          "regime": "LATE_CYCLE"
        }
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "createdAt": "2026-02-28T14:30:00Z",
        "payload": {
          "reason": "BASE_RATE_THRESHOLD_CROSSED",
          "regime": "EXPANSION"
        }
      }
    ],
    "primaryRegime": "LATE_CYCLE",
    "regimeChanges": 2,
    "dominantReasons": [
      "CURVE_INVERSION_DEEPENED",
      "BASE_RATE_THRESHOLD_CROSSED"
    ],
    "weekOverWeekDelta": {
      "alertCountChange": 1,
      "newReasons": ["CURVE_INVERSION_DEEPENED"],
      "stabilityScore": 0.75
    }
  },
  "alertCount": 47,
  "deliveryCount": 23
}

​
Caching Behavior

  • Runtime: Edge
  • Revalidation: Dynamic (no static cache)
  • Generated on-demand from current regime alert storage

​
Weekly Window

The digest considers alerts from the past 7 days (168 hours) from the current timestamp. This rolling window ensures the digest always reflects recent activity.

​
Use Cases

  • Weekly team briefings on market conditions
  • Regime stability monitoring
  • Trend identification across multiple alerts
  • Email/Slack digest automation
  • Dashboard summary widgets

Build docs developers (and LLMs) love

Get started for freeTalk to us