Create, list, or evaluate rate threshold alerts | Freight Rate Intelligence API

curl -X POST https://freightrateintelligence.com/v1/alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "operation": "CREATE"
}'

{
  "ok": true,
  "data": {
    "operation": "string",
    "alerts": [
      {
        "alert_id": "string",
        "lane": "string",
        "origin": "string",
        "destination": "string",
        "mode": "string",
        "equipment": "string",
        "equipment_display": "string",
        "trigger_type": "string",
        "threshold_value": 1.1,
        "threshold_unit": "USD_per_mile",
        "threshold_display": "string",
        "notify_via": [
          "string"
        ],
        "status": "ACTIVE",
        "triggered": true,
        "triggered_at": "2024-01-15T09:30:00Z",
        "triggered_rate": 1.1,
        "triggered_rate_display": "string",
        "trigger_history": [
          {
            "triggered_at": "string",
            "rate_at_trigger": 1.1,
            "threshold": 1.1,
            "receipt_id": "string"
          }
        ],
        "current_rate": 1.1,
        "current_rate_display": "string",
        "gap_to_threshold": 1.1,
        "gap_display": "string",
        "would_trigger_now": true,
        "monitoring": {
          "check_interval": "string",
          "next_check_at": "2024-01-15T09:30:00Z",
          "data_sources": [
            "string"
          ],
          "note": "string"
        },
        "confidence": {
          "level": "HIGH",
          "score": 1.1,
          "label": "string",
          "factors": [
            "string"
          ]
        },
        "created_at": "2024-01-15T09:30:00Z"
      }
    ],
    "total": 1,
    "evaluations_run": 1,
    "alerts_triggered": 1,
    "model_type": "RATE_ALERT",
    "model_disclaimer": "string"
  },
  "receipt_id": "rcpt_01abc...",
  "auth_obj_id": "auth_01xyz..."
}

CRUD operations for rate monitoring alerts. Create alerts that trigger when rates cross a threshold, list active alerts, delete alerts, or evaluate all active alerts against current rates. Requires Starter tier.

Authentication

AuthorizationBearer

Your Freight Rate Intelligence API key. Get one at freightrateintelligence.com/dashboard/settings

Request

This endpoint expects an object.

operationenumRequired

CREATE: new alert. LIST: all subscriber alerts. GET: single alert by ID. UPDATE: modify alert. DELETE: remove alert. EVALUATE: check all active alerts.

alertobjectOptional

Alert definition (required for CREATE)

alert_idstring or nullOptional

Alert identifier. Required for GET/UPDATE/DELETE. Omit for CREATE (server generates).

Response

Alert operation result with receipt

okboolean

dataobject

Skill-specific response data

receipt_idstring

auth_obj_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error