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-19 07:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update rest documentation for filter_entity_id as its required (#1770)

Browse Source
This commit is contained in:
J. Nick Koston 2023-05-06 18:05:14 -05:00 committed by GitHub
parent 8698afb9e3
commit 391fa8c3bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api/rest.md
View File

@ -201,9 +201,12 @@ Returns an array of state changes in the past. Each object contains further deta
The `<timestamp>` (`YYYY-MM-DDThh:mm:ssTZD`) is optional and defaults to 1 day before the time of the request. It determines the beginning of the period. The `<timestamp>` (`YYYY-MM-DDThh:mm:ssTZD`) is optional and defaults to 1 day before the time of the request. It determines the beginning of the period.
You can pass the following optional GET parameters: The following parameters are required:
- `filter_entity_id=<entity_ids>` to filter on one or more entities - comma separated. - `filter_entity_id=<entity_ids>` to filter on one or more entities - comma separated.
You can pass the following optional GET parameters:
- `end_time=<timestamp>` to choose the end of the period in URL encoded format (defaults to 1 day). - `end_time=<timestamp>` to choose the end of the period in URL encoded format (defaults to 1 day).
- `minimal_response` to only return `last_changed` and `state` for states other than the first and last state (much faster). - `minimal_response` to only return `last_changed` and `state` for states other than the first and last state (much faster).
- `no_attributes` to skip returning attributes from the database (much faster). - `no_attributes` to skip returning attributes from the database (much faster).