Skip to content

Document the query parameter of the live/logs/read endpoint - #2691

Merged
AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-live-logs-query-param
Sep 18, 2026
Merged

AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-live-logs-query-param

Conversation

@AlexCatarino

@AlexCatarino AlexCatarino commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add the optional query parameter to ReadLiveLogsRequest. It is missing from Document the backtests/read/log endpoint #2686, which only documented it for backtest logs.
  • Update the length description to say it counts the rows that match the query.
  • Update the deploymentOffset description to say it counts all rows, even with a query.
  • Add "query": None to the live logs request in the Read Live Algorithm example.
  • Regenerate the Live Management > Read Live Algorithm > Logs pages.

Test plan

  • Called /live/logs/read on a running live algorithm. Confirmed that query is optional (omitted, null, and "" return all lines), that the filter is case-insensitive, that startLine/endLine index the filtered lines, that length counts the matching lines, that it works with deploymentLogs, and that the 250-line limit still applies.
  • Confirmed that deploymentOffset is unchanged by query (1756 with and without query: "order", while only 629 matching rows precede the deployment).
  • Ran python code-generators/API-Reference-Code-Generator.py; only the live Logs pages changed.
  • Check the rendered pages on the docs site.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@AlexCatarino
AlexCatarino merged commit e7c9568 into QuantConnect:master Sep 18, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the feature-live-logs-query-param branch September 18, 2026 18:09
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