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-15 21:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix curl samples for history end point in REST API documentation (#1899)

Browse Source 
Co-authored-by: 4nd2in <andrin.weiler@smoca.ch>
This commit is contained in:
4nd2in 2023-10-06 21:09:04 +02:00 committed by GitHub
parent 7a01aea2e2
commit 1fd39795ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/api/rest.md
View File

@ -201,7 +201,7 @@ 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 following parameters are required:
The following parameters are **required**:
- `filter_entity_id=<entity_ids>` to filter on one or more entities - comma separated.
@ -281,31 +281,28 @@ Example with `minimal_response`
Sample `curl` commands:
```shell
# History of the entity 'sensor.temperature' of the past day (default)
curl \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00
"http://localhost:8123/api/history/period?filter_entity_id=sensor.temperature"
```
```shell
# Minimal history of the entity 'sensor.temperature' and 'sensor.kitchen_temperature' of the past day where the beginning date is set manually to 2023-09-04
curl \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
"http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?minimal_response"
"http://localhost:8123/api/history/period/2023-09-04T00:00:00+02:00?filter_entity_id=sensor.temperature,sensor.kitchen_temperature&minimal_response"
```
```shell
# History of the entity 'sensor.temperature' during the period from 2021-09-04 to 2023-09-04
# Using URL encoded timestamps
curl \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
"http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?filter_entity_id=sensor.temperature"
```
```shell
curl \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
"http://localhost:8123/api/history/period/2016-12-29T00:00:00+02:00?end_time=2016-12-31T00%3A00%3A00%2B02%3A00"
"http://localhost:8123/api/history/period/2021-09-04T00%3A00%3A00%2B02%3A00?end_time=2023-09-04T00%3A00%3A00%2B02%3A00&filter_entity_id=sensor.temperature"
```
</ApiEndpoint>