Get monitor

Get monitor

curl --request GET \
  --url https://api.itoflow.ai/watchlists/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.itoflow.ai/watchlists/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent_enabled": true,
  "created_at": "<string>",
  "current_version": 2,
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_status": "paused",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "user",
  "mandate": "<string>",
  "name": "<string>",
  "profile": "research",
  "profile_config": {
    "comparators": {
      "benchmark": {
        "basket_symbol": "<string>",
        "index_symbol": "<string>",
        "name": "<string>"
      },
      "peer_funds": [
        {
          "name": "<string>",
          "symbol": "<string>"
        }
      ]
    },
    "custom": {},
    "subject": {
      "name": "<string>",
      "portfolio_id": "<string>"
    },
    "thresholds": {
      "aum_scenarios": [
        123
      ],
      "cash_pct": 1,
      "comparator": "<string>",
      "irs_5pct_bucket_pct": 1,
      "liquidity": {
        "adtv_window_months": 123,
        "illiquid_days": 1,
        "participation": 0
      },
      "metrics": {},
      "relative_weight": {
        "country": 1,
        "custom_group": 1,
        "sector": 1,
        "single_name": 1
      },
      "single_issuer_pct": 123,
      "tracking_error_budget": 1,
      "warning_fraction": 0,
      "warnings": {
        "cash_pct": 123,
        "irs_5pct_bucket_pct": 123,
        "liquidity": {
          "illiquid_days": 123
        },
        "relative_weight": {
          "country": 123,
          "custom_group": 123,
          "sector": 123,
          "single_name": 123
        },
        "single_issuer_pct": 123,
        "tracking_error_budget": 123
      }
    }
  },
  "recurrence": {
    "kind": "daily",
    "local_time": "<string>",
    "timezone": "<string>"
  },
  "symbol_notes": {},
  "symbols": [
    "AAPL.US"
  ],
  "updated_at": "<string>",
  "user_email": "jsmith@example.com",
  "mandate_version": {
    "author_type": "user",
    "change_description": "<string>",
    "effective_from": "<string>",
    "effective_to": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mandate": "<string>",
    "profile": "research",
    "profile_config": {
      "comparators": {
        "benchmark": {
          "basket_symbol": "<string>",
          "index_symbol": "<string>",
          "name": "<string>"
        },
        "peer_funds": [
          {
            "name": "<string>",
            "symbol": "<string>"
          }
        ]
      },
      "custom": {},
      "subject": {
        "name": "<string>",
        "portfolio_id": "<string>"
      },
      "thresholds": {
        "aum_scenarios": [
          123
        ],
        "cash_pct": 1,
        "comparator": "<string>",
        "irs_5pct_bucket_pct": 1,
        "liquidity": {
          "adtv_window_months": 123,
          "illiquid_days": 1,
          "participation": 0
        },
        "metrics": {},
        "relative_weight": {
          "country": 1,
          "custom_group": 1,
          "sector": 1,
          "single_name": 1
        },
        "single_issuer_pct": 123,
        "tracking_error_budget": 1,
        "warning_fraction": 0,
        "warnings": {
          "cash_pct": 123,
          "irs_5pct_bucket_pct": 123,
          "liquidity": {
            "illiquid_days": 123
          },
          "relative_weight": {
            "country": 123,
            "custom_group": 123,
            "sector": 123,
            "single_name": 123
          },
          "single_issuer_pct": 123,
          "tracking_error_budget": 123
        }
      }
    },
    "recurrence": {
      "kind": "daily",
      "local_time": "<string>",
      "timezone": "<string>"
    },
    "source_chat_id": "<string>",
    "symbol_notes": {},
    "symbols": [
      "AAPL.US"
    ],
    "version_number": 2,
    "watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "model_key": "luna"
  },
  "model_key": "luna",
  "runtime_move_pending": true,
  "version_history": [
    {
      "author_type": "user",
      "change_description": "<string>",
      "effective_from": "<string>",
      "effective_to": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mandate": "<string>",
      "profile": "research",
      "profile_config": {
        "comparators": {
          "benchmark": {
            "basket_symbol": "<string>",
            "index_symbol": "<string>",
            "name": "<string>"
          },
          "peer_funds": [
            {
              "name": "<string>",
              "symbol": "<string>"
            }
          ]
        },
        "custom": {},
        "subject": {
          "name": "<string>",
          "portfolio_id": "<string>"
        },
        "thresholds": {
          "aum_scenarios": [
            123
          ],
          "cash_pct": 1,
          "comparator": "<string>",
          "irs_5pct_bucket_pct": 1,
          "liquidity": {
            "adtv_window_months": 123,
            "illiquid_days": 1,
            "participation": 0
          },
          "metrics": {},
          "relative_weight": {
            "country": 1,
            "custom_group": 1,
            "sector": 1,
            "single_name": 1
          },
          "single_issuer_pct": 123,
          "tracking_error_budget": 1,
          "warning_fraction": 0,
          "warnings": {
            "cash_pct": 123,
            "irs_5pct_bucket_pct": 123,
            "liquidity": {
              "illiquid_days": 123
            },
            "relative_weight": {
              "country": 123,
              "custom_group": 123,
              "sector": 123,
              "single_name": 123
            },
            "single_issuer_pct": 123,
            "tracking_error_budget": 123
          }
        }
      },
      "recurrence": {
        "kind": "daily",
        "local_time": "<string>",
        "timezone": "<string>"
      },
      "source_chat_id": "<string>",
      "symbol_notes": {},
      "symbols": [
        "AAPL.US"
      ],
      "version_number": 2,
      "watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "model_key": "luna"
    }
  ]
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "code": "MONITOR_LIFECYCLE_UNAVAILABLE",
  "error": "MONITOR_LIFECYCLE_UNAVAILABLE",
  "message": "<string>"
}

GET

https://api.itoflow.ai

watchlists

{id}

Get monitor

curl --request GET \
  --url https://api.itoflow.ai/watchlists/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.itoflow.ai/watchlists/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent_enabled": true,
  "created_at": "<string>",
  "current_version": 2,
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_status": "paused",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "user",
  "mandate": "<string>",
  "name": "<string>",
  "profile": "research",
  "profile_config": {
    "comparators": {
      "benchmark": {
        "basket_symbol": "<string>",
        "index_symbol": "<string>",
        "name": "<string>"
      },
      "peer_funds": [
        {
          "name": "<string>",
          "symbol": "<string>"
        }
      ]
    },
    "custom": {},
    "subject": {
      "name": "<string>",
      "portfolio_id": "<string>"
    },
    "thresholds": {
      "aum_scenarios": [
        123
      ],
      "cash_pct": 1,
      "comparator": "<string>",
      "irs_5pct_bucket_pct": 1,
      "liquidity": {
        "adtv_window_months": 123,
        "illiquid_days": 1,
        "participation": 0
      },
      "metrics": {},
      "relative_weight": {
        "country": 1,
        "custom_group": 1,
        "sector": 1,
        "single_name": 1
      },
      "single_issuer_pct": 123,
      "tracking_error_budget": 1,
      "warning_fraction": 0,
      "warnings": {
        "cash_pct": 123,
        "irs_5pct_bucket_pct": 123,
        "liquidity": {
          "illiquid_days": 123
        },
        "relative_weight": {
          "country": 123,
          "custom_group": 123,
          "sector": 123,
          "single_name": 123
        },
        "single_issuer_pct": 123,
        "tracking_error_budget": 123
      }
    }
  },
  "recurrence": {
    "kind": "daily",
    "local_time": "<string>",
    "timezone": "<string>"
  },
  "symbol_notes": {},
  "symbols": [
    "AAPL.US"
  ],
  "updated_at": "<string>",
  "user_email": "jsmith@example.com",
  "mandate_version": {
    "author_type": "user",
    "change_description": "<string>",
    "effective_from": "<string>",
    "effective_to": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mandate": "<string>",
    "profile": "research",
    "profile_config": {
      "comparators": {
        "benchmark": {
          "basket_symbol": "<string>",
          "index_symbol": "<string>",
          "name": "<string>"
        },
        "peer_funds": [
          {
            "name": "<string>",
            "symbol": "<string>"
          }
        ]
      },
      "custom": {},
      "subject": {
        "name": "<string>",
        "portfolio_id": "<string>"
      },
      "thresholds": {
        "aum_scenarios": [
          123
        ],
        "cash_pct": 1,
        "comparator": "<string>",
        "irs_5pct_bucket_pct": 1,
        "liquidity": {
          "adtv_window_months": 123,
          "illiquid_days": 1,
          "participation": 0
        },
        "metrics": {},
        "relative_weight": {
          "country": 1,
          "custom_group": 1,
          "sector": 1,
          "single_name": 1
        },
        "single_issuer_pct": 123,
        "tracking_error_budget": 1,
        "warning_fraction": 0,
        "warnings": {
          "cash_pct": 123,
          "irs_5pct_bucket_pct": 123,
          "liquidity": {
            "illiquid_days": 123
          },
          "relative_weight": {
            "country": 123,
            "custom_group": 123,
            "sector": 123,
            "single_name": 123
          },
          "single_issuer_pct": 123,
          "tracking_error_budget": 123
        }
      }
    },
    "recurrence": {
      "kind": "daily",
      "local_time": "<string>",
      "timezone": "<string>"
    },
    "source_chat_id": "<string>",
    "symbol_notes": {},
    "symbols": [
      "AAPL.US"
    ],
    "version_number": 2,
    "watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "model_key": "luna"
  },
  "model_key": "luna",
  "runtime_move_pending": true,
  "version_history": [
    {
      "author_type": "user",
      "change_description": "<string>",
      "effective_from": "<string>",
      "effective_to": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mandate": "<string>",
      "profile": "research",
      "profile_config": {
        "comparators": {
          "benchmark": {
            "basket_symbol": "<string>",
            "index_symbol": "<string>",
            "name": "<string>"
          },
          "peer_funds": [
            {
              "name": "<string>",
              "symbol": "<string>"
            }
          ]
        },
        "custom": {},
        "subject": {
          "name": "<string>",
          "portfolio_id": "<string>"
        },
        "thresholds": {
          "aum_scenarios": [
            123
          ],
          "cash_pct": 1,
          "comparator": "<string>",
          "irs_5pct_bucket_pct": 1,
          "liquidity": {
            "adtv_window_months": 123,
            "illiquid_days": 1,
            "participation": 0
          },
          "metrics": {},
          "relative_weight": {
            "country": 1,
            "custom_group": 1,
            "sector": 1,
            "single_name": 1
          },
          "single_issuer_pct": 123,
          "tracking_error_budget": 1,
          "warning_fraction": 0,
          "warnings": {
            "cash_pct": 123,
            "irs_5pct_bucket_pct": 123,
            "liquidity": {
              "illiquid_days": 123
            },
            "relative_weight": {
              "country": 123,
              "custom_group": 123,
              "sector": 123,
              "single_name": 123
            },
            "single_issuer_pct": 123,
            "tracking_error_budget": 123
          }
        }
      },
      "recurrence": {
        "kind": "daily",
        "local_time": "<string>",
        "timezone": "<string>"
      },
      "source_chat_id": "<string>",
      "symbol_notes": {},
      "symbols": [
        "AAPL.US"
      ],
      "version_number": 2,
      "watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "model_key": "luna"
    }
  ]
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "error": "<string>",
  "available": "<string>",
  "billing_action": {
    "href": "<string>",
    "kind": "upgrade",
    "label": "<string>"
  },
  "code": "<string>",
  "currentVersion": 123,
  "details": "<unknown>",
  "expectedVersion": 123,
  "message": "<string>",
  "requested": "<string>",
  "usage": "<unknown>"
}

{
  "code": "MONITOR_LIFECYCLE_UNAVAILABLE",
  "error": "MONITOR_LIFECYCLE_UNAVAILABLE",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Itoflow access token issued for the Itoflow API.

Path Parameters

string<uuid>

required

Monitor UUID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

include_version_history

enum<string>

Available options:

true,

false

mandate_version

integer

Required range: x >= 1

Response

Monitor

agent_enabled

boolean

required

created_at

string

required

current_version

integer

required

Required range: x >= 1

current_version_id

string<uuid>

required

execution_status

enum<string>

required

Available options:

paused,

running

string<uuid>

required

kind

enum<string>

required

Available options:

user,

system

mandate

string

required

name

string

required

profile

enum<string>

required

Available options:

research,

fund_oversight

profile_config

object | null

required

Optional machine-readable configuration for the monitor profile, required by fund_oversight and rejected for research. Set subject.portfolio_id to a portfolio the monitor owner holds with no linked strategy; it is the only portfolio id here. Name the benchmark index, the benchmark basket and each peer fund by qualified symbol, for example GSPC.INDX, SPY.US and IVV.US, never a display name; each peer needs a holdings book. Put oversight policy, priorities and explanation preferences in the mandate, and durable owner policy without a typed field in custom, never a copy of current portfolio state. Use only the named threshold fields, each in the unit its description gives; unknown threshold keys are rejected. To change where a limit warns, set thresholds.warnings under the limit's own field, for example {"warnings": {"tracking_error_budget": 6}}. To change one row of the latest report, key thresholds.metrics by the metric_key that report shows for it.

Show child attributes

recurrence

object

required

Option 1
Option 2
Option 3

Show child attributes

symbol_notes

object

required

Show child attributes

symbols

string[]

required

Pattern: ^[A-Z0-9][A-Z0-9._/&-]{0,38}\.[A-Z0-9]{2,10}$

updated_at

string

required

user_email

string<email>

required

mandate_version

object

Show child attributes

model_key

enum<string>

Available options:

luna,

sol,

sol61,

astra,

sonnet55,

opus55,

terra61,

haiku55,

fusion_deep,

fusion_quick,

fusion_light

runtime_move_pending

boolean

True while the monitor is moving to the new runtime. Runs, schedule changes, edits and deletion are refused until the move finishes; reports stay readable. Monitor reads always include it.

version_history

object[]

Show child attributes

Get started

Platform

Use cases

Features

HTTP API

Troubleshooting

Endpoints

Authorizations

Path Parameters

Query Parameters

Response