Decision Monitors

Get monitor details

Returns detailed information about a specific monitor including its configuration, conditions, and last activity timestamps.

Authentication required: Pass your API key in the X-API-Key header. You can only access monitors belonging to your API key.

get/v1/monitors/{id}

Request

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

Path parameters

idstring required
Example:mon_abc123xyz

Monitor ID (e.g., mon_abc123xyz)

Response

Monitor details

idstring required

Unique monitor ID

namestring required

Human-readable name

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

Current status of the monitor

subscribed_statesstring[] required

States to watch for rate changes. Use ["*"] for all states.

subscribed_product_typesstring[] required

Product types to watch. Use ["*"] for all types.

cooldown_hoursinteger required

Hours to wait between triggers

webhook_urlstring uri required

Webhook URL for notifications (HTTPS only)

webhook_signing_secret_prefixstring required

First 10 characters of the signing secret, for identifying WHICH secret a monitor is on without storing or re-showing the secret itself. The full secret is returned only once, at creation.

last_evaluated_atstring date-time nullable

Last time this monitor was evaluated

last_triggered_atstring date-time nullable

Last time this monitor triggered a webhook

created_atstring date-time required

When the monitor was created

updated_atstring date-time required

When the monitor was last updated

Example response

{
  "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"
}

Changes

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