Add more info about the /api/history/period route (#2699)

bokub · fabaff · commit e24bbff26da1 · 2017-05-25T10:10:16.000+02:00
diff --git a/source/developers/rest_api.markdown b/source/developers/rest_api.markdown
@@ -202,6 +202,12 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
 #### {% linkable_title GET /api/history/period/&lt;timestamp> %}
 Returns an array of state changes in the past. Each object contains further details for the entities.
 
+The `<timestamp>` 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:
+  - `filter_entity_id=<entity_id>` to filter on a single entity
+  - `end_time=<timestamp>` to choose the end of the period (defaults to 1 day)
+
 ```json
 [
     [

Original file line number	Diff line number	Diff line change
`@@ -202,6 +202,12 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \`
`202`	`202`	`#### {% linkable_title GET /api/history/period/<timestamp> %}`
`203`	`203`	`Returns an array of state changes in the past. Each object contains further details for the entities.`
`204`	`204`
	`205`	+The `<timestamp>` is optional and defaults to 1 day before the time of the request. It determines the beginning of the period.
	`206`	`+`
	`207`	`+You can pass the following optional GET parameters:`
	`208`	+ - `filter_entity_id=<entity_id>` to filter on a single entity
	`209`	+ - `end_time=<timestamp>` to choose the end of the period (defaults to 1 day)
	`210`	`+`
`205`	`211`	```json
`206`	`212`	`[`
`207`	`213`	`[`