Run dataset: regime-segments (run_id comes from GET /v1/backtests/{id})

The numbers behind a finished run. Requires the resultsHistory plan feature. The same data is served to the app at /api/runs/{runId}/regime-segments under a session JWT; this is the key-authed mirror. Page with offset+limit, or ask for maxPoints to get an even downsample of the WHOLE range in one call. The price action regime block timeline as run length spans {start, end, state} (epoch ms, end inclusive; 1 Trend Up, -1 Trend Down, 0 Quiet Range, 2 Volatile Chop; gaps = bars the classifier declined to label). Its own dataset since 2026-09-14: metrics.regimeBreakdown carries only segmentCount. Chart data for the regime tinted views; per trade attribution is on the trade rows.

get/v1/runs/{runId}/regime-segments

Request

  • Base URL: https://app.texttoquant.com/api
  • URL: https://app.texttoquant.com/api/v1/runs/{runId}/regime-segments
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

runIdstring uuid required

Query parameters

startstring date-time

ISO 8601 — clip the range

endstring date-time

ISO 8601 — clip the range

limitinteger

First N rows (truncates a long run to its beginning)

maxPointsinteger

Even downsample to at most N rows across the whole range

offsetinteger
raw'1'

Gzip passthrough opt-in; only the literal "1" enables it

Response

Success

successtrue required
dataobject required

Changes

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