jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-13 04:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blog post about long term statistic API changes (#1531)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Erik Montnemery 2022-11-16 20:59:30 +01:00 committed by GitHub
parent 3268a81235
commit 8dfbbcb178
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
blog/2022-11-16-statistics_refactoring.md Normal file
View File

@ -0,0 +1,29 @@
---
author: Erik Montnemery
authorURL: https://github.com/emontnemery
title: "Changes to long term statistics APIs"
---
Some changes have been made to the long-term statistics-related APIs to reduce response size and database load.
The changes are implemented in [this PR](https://github.com/home-assistant/core/pull/82131).
This affects authors of code calling the following WS APIs:
- `recorder/statistics_during_period`
- A new optional parameter `types` has been added, which allows providing a list of statistics characteristics to include in the response. Possible values are: `"last_reset"`, `"max"`, `"mean"`, `"min"`, `"state"`, `"sum"`
- Timestamps `start`, `end` and `last_reset` are now an integer number of ms since the UNIX epoch instead of ISO-formatted strings. The new format means the timestamps can be passed directly to js `Date()` constructor.
- The `statistic_id` is no longer repeated for each list item in the returned map. This was not used because the return type is a map, keyed by `statistic_id`.
This affects authors of code calling the following Python APIs:
- `homeassistant.recorder.statistics.get_last_short_term_statistics`
- A new parameter `types` has been added, which allows providing a set of statistics characteristics to include in the response. Possible values are: `"last_reset"`, `"max"`, `"mean"`, `"min"`, `"state"`, `"sum"`
- Timestamps `start`, `end` and `last_reset` are now an `datetime` objects instead of ISO-formatted strings.
- The `statistic_id` is no longer repeated for each list item in the returned map. This was not used because the return type is a map, keyed by `statistic_id`.
- `homeassistant.recorder.statistics.get_latest_short_term_statistics`
- A new parameter `types` has been added, which allows providing a set of statistics characteristics to include in the response. Possible values are: `"last_reset"`, `"max"`, `"mean"`, `"min"`, `"state"`, `"sum"`
- Timestamps `start`, `end` and `last_reset` are now an `datetime` objects instead of ISO-formatted strings.
- The `statistic_id` is no longer repeated for each list item in the returned map. This was not used because the return type is a map, keyed by `statistic_id`.
- `homeassistant.recorder.statistics.statistics_during_period`
- A new parameter `types` has been added, which allows providing a set of statistics characteristics to include in the response. Possible values are: `"last_reset"`, `"max"`, `"mean"`, `"min"`, `"state"`, `"sum"`
- Timestamps `start`, `end` and `last_reset` are now an `datetime` objects instead of ISO-formatted strings.
- The `statistic_id` is no longer repeated for each list item in the returned map. This was not used because the return type is a map, keyed by `statistic_id`.