Add Recorder's get_statistics action docs #39492

abmantis · 2025-06-11T20:57:03Z

Proposed change

Add missing docs for home-assistant/core#142602

This replaces #39480 since that was targeted to next and did not made it in time.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Introduce recorder.get_statistics service core#142602
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Added documentation for a new action that allows retrieving historical statistics for multiple entities from the recorder database, including details on required and optional parameters and an example usage.

home-assistant · 2025-06-11T20:57:07Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

netlify · 2025-06-11T20:57:50Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`11e6e2d`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/6849eda2f2a799000838a25d
😎 Deploy Preview	https://deploy-preview-39492--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-06-11T20:59:29Z

📝 Walkthrough

Walkthrough

A new action, recorder.get_statistics, has been added to the recorder integration documentation. This action enables retrieval of historical statistics for specified entities, detailing required and optional parameters, supported statistic types, and unit conversion options. An example YAML usage is included in the documentation update.

Changes

File	Change Summary
source/_integrations/recorder.markdown	Documented new `recorder.get_statistics` action, its parameters, supported types, and example usage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Recorder Integration

    User->>Recorder Integration: Call recorder.get_statistics(statistic_ids, start_time, end_time, period, types, units)
    Recorder Integration-->>User: Return requested historical statistics data

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

source/_integrations/recorder.markdown (4)
258-259: Expand description to include all statistic types
The overview currently mentions “mean, min, max, or sum” but the types parameter also supports change, last_reset, and state. Listing all supported types here will help users understand their options.

262-264: Document expected time format
The start_time and end_time fields accept datetime strings. Please specify the expected format (e.g., ISO 8601: YYYY-MM-DDThh:mm:ssZ) to prevent parsing errors.

269-269: Standardize example heading
Other actions use headings like “#### Example usage” or “#### Example automation …”. Consider renaming “#### Example using get_statistics” to “#### Example usage” or “#### Example automation for get_statistics” for consistency.

286-286: Adjust example YAML indentation
In the snippet, response_variable is unindented. To align with data, indent it under the action block:
 action: recorder.get_statistics
 data:
   ...
-response_variable: consumption_stats
+  response_variable: consumption_stats

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between cb5e16a and 11e6e2d.

📒 Files selected for processing (1)

source/_integrations/recorder.markdown (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (1)

source/_integrations/recorder.markdown (1)

256-256: Confirm service naming matches core implementation
Ensure that the documented action recorder.get_statistics aligns exactly with the service name registered in the Recorder integration (PR 142602). Discrepancies will lead to broken automations.

abmantis · 2025-06-11T21:07:46Z

Thanks @MartinHjelmare !

abmantis added 3 commits June 11, 2025 21:54

Add Recorder's get_service action docs

e16f237

Fix optionals

b3cf77f

Use simpler date format

11e6e2d

abmantis requested a review from a team as a code owner June 11, 2025 20:57

home-assistant bot assigned abmantis Jun 11, 2025

home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jun 11, 2025

abmantis mentioned this pull request Jun 11, 2025

Add Recorder's get_service action docs #39480

Closed

8 tasks

coderabbitai bot reviewed Jun 11, 2025

View reviewed changes

MartinHjelmare changed the title ~~Add Recorder's get_service action docs~~ Add Recorder's get_statistics action docs Jun 11, 2025

MartinHjelmare approved these changes Jun 11, 2025

View reviewed changes

MartinHjelmare merged commit 89c198f into current Jun 11, 2025
9 checks passed

MartinHjelmare deleted the recorder_get_service_current branch June 11, 2025 21:05

home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jun 11, 2025

Passific mentioned this pull request Jun 12, 2025

No documentation for recorder.get_statistics action #39479

Closed

github-actions bot locked and limited conversation to collaborators Jun 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add Recorder's get_statistics action docs #39492

Add Recorder's get_statistics action docs #39492

Uh oh!

abmantis commented Jun 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

home-assistant bot commented Jun 11, 2025

Uh oh!

netlify bot commented Jun 11, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 11, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

abmantis commented Jun 11, 2025

Uh oh!

Uh oh!

Uh oh!

Add Recorder's get_statistics action docs #39492

Add Recorder's get_statistics action docs #39492

Uh oh!

Conversation

abmantis commented Jun 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

home-assistant bot commented Jun 11, 2025

Uh oh!

netlify bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Jun 11, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abmantis commented Jun 11, 2025

Uh oh!

Uh oh!

abmantis commented Jun 11, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)