Decision Monitors

List monitors for API key

Returns all monitors associated with the authenticated API key. Supports pagination and optional filtering by status.

Authentication required: Pass your API key in the X-API-Key header.

get/v1/monitors

Request

Base URL: https://api.rateapi.dev
URL: https://api.rateapi.dev/v1/monitors
Auth: API key in header X-API-Key

Query parameters

status'active' | 'paused' | 'disabled'

Filter by monitor status

limitinteger

Maximum number of monitors to return (1-100)

offsetinteger

Number of monitors to skip for pagination

Response

List of monitors

totalinteger required

Total number of monitors matching the query

limitinteger required

Maximum number of monitors returned

offsetinteger required

Number of monitors skipped

Example response

{
  "monitors": [
    {
      "id": "mon_abc123xyz",
      "name": "California Refinance Alerts",
      "status": "active",
      "decision_context": {
        "credit_score_band": "excellent",
        "income_band": "high",
        "loan_amount_band": "250k_500k",
        "state": "CA",
        "product_type": "mortgage",
        "intent": "refinance",
        "term_months": 360,
        "rate_type": "fixed",
        "prefer_credit_unions": true
      },
      "conditions": [
        {
          "field": "apr",
          "operator": "lt",
          "value": 6.5
        }
      ],
      "subscribed_states": [
        "CA",
        "TX"
      ],
      "subscribed_product_types": [
        "mortgage"
      ],
      "cooldown_hours": 24,
      "webhook_url": "https://your-app.com/webhooks/rate-alerts",
      "webhook_signing_secret_prefix": "whsec_a1b2",
      "last_evaluated_at": "2024-01-15T12:00:00.000Z",
      "last_triggered_at": "2024-01-14T08:30:00.000Z",
      "created_at": "2024-01-10T09:00:00.000Z",
      "updated_at": "2024-01-15T12:00:00.000Z"
    }
  ],
  "total": 5,
  "limit": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.