Documentation - WhenBRRR

Getting Started

WhenBRRR is an enterprise market intelligence platform that helps you make data-driven marketing budget allocation decisions based on macroeconomic signals.

Key Concepts

MTI (Money Tide Index): Measures market liquidity conditions based on Fed balance sheet, M2 money supply, and other macroeconomic indicators
SNI (Sales Nimbus Index): Combines MTI with seasonality and velocity adjustments for precise budget recommendations
Regime Classification: Markets are classified into High Tide, Tailwind, Neutral, or Low Tide regimes
Budget Allocation: Deterministic formula applies regime-based multipliers to optimize channel budgets

API Reference

All API endpoints require authentication via X-API-Key header.

Budget Allocation

POST /api/v12/allocate
Headers: X-API-Key: your-api-key
Body: {
  "mti": 1.2,
  "sni": 0.8,
  "sni_velocity": 0.1,
  "total_budget": 100000,
  "channels": {...},
  "risk_posture": "balanced",
  "forecast": { "p10": 85000, "p50": 100000, "p90": 120000 }
}

MTI Dashboard Data

GET /mti/api/current
Returns current MTI, SNI, regime, and forecasts

AI Insights

GET /mti/api/v12/ai/insights
Returns professional market analysis and recommendations

Interactive Budget Allocation Explorer

Craft real requests for the v12 allocation endpoints, preview the payload/cURL snippet, and execute them without leaving the docs.

Idle

Environment Requests are sent client-side using fetch, so your API key never leaves the browser tab.

Endpoint

X-API-Key Use a dev key; enterprise keys keep full audit logging.

Total budget ($)

Risk posture

MTI

SNI

SNI velocity

Forecast p10

Forecast p50

Forecast p90

Current allocations (JSON) Provide channel → spend pairs (USD). We'll validate the JSON before sending.

Request payload

cURL snippet

Live response Status: waiting

// Send a request to view the live response

Cross-origin requests must comply with your environment's CORS rules. If you see a CORS error, switch to "Current host" or run the docs from the same domain as your API.

Integrations

WhenBRRR integrates with leading CRM and marketing platforms:

HubSpot: Sync budget allocations, fetch marketing data, create deals
Salesforce: Two-way sync with campaign budgets and opportunity data
NimbusOS MCP: AI-powered automation via Model Context Protocol

Understanding Regimes

High Tide (MTI > 1.0): Abundant liquidity, scale top-of-funnel channels
Tailwind (0 < MTI ≤ 1.0): Positive conditions, moderate growth
Neutral (-0.5 ≤ MTI ≤ 0): Focus on efficiency and proven channels
Low Tide (MTI < -0.5): Reduced liquidity, preserve cash, focus on ROI

Support

Need help? Visit our Support Center or view Examples.