Skip to content

Document the backtests/read/log endpoint - #2686

Merged
AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-backtest-logs-api-docs
Sep 17, 2026
Merged

AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-backtest-logs-api-docs

Conversation

@AlexCatarino

Copy link
Copy Markdown
Member

Summary

  • Add the undocumented /backtests/read/log endpoint to QuantConnect-Platform-2.0.0.yaml, with ReadBacktestLogsRequest and ReadBacktestLogsResponse schemas.
  • Generate its pages under Backtest Management > Read Backtest > Logs, last in the section to mirror where /live/logs/read sits under Read Live Algorithm.
  • State in the endpoint description that, per the Terms and Conditions, it may not be used to export market data or other dataset information, with a link to Log Quotas.
  • Add a "Read Backtest Logs" request to the shared backtest management example.
  • Add the missing 04-06 entries to the Read Backtest landing 00.json.

Test plan

  • Called the endpoint against a completed cloud backtest. Confirmed the payload (projectId, backtestId, start, end, query), that query must be present but accepts null or "", that the filter is case-insensitive and start/end index the filtered lines, that end is exclusive, and that a request is limited to 200 lines (Log lines can be read in pages up to 200 lines).
  • Ran python code-generators/API-Reference-Code-Generator.py; only the new 06 Logs folder changed.
  • Executed the new example block against the live API and it returned the logs.
  • Check the rendered pages on the docs site.

Add /backtests/read/log to the OpenAPI spec and generate its pages under
Read Backtest > Logs, mirroring the position of /live/logs/read. State
that the endpoint cannot be used to export market data, and add a logs
request to the backtest management example.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@AlexCatarino
AlexCatarino merged commit c336fee into QuantConnect:master Sep 17, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the feature-backtest-logs-api-docs branch September 17, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant