From e24bbff26da19c7ce383237fa06d0f0b4bedd96f Mon Sep 17 00:00:00 2001 From: Boris K Date: Thu, 25 May 2017 10:10:16 +0200 Subject: [PATCH] Add more info about the /api/history/period route (#2699) --- source/developers/rest_api.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/developers/rest_api.markdown b/source/developers/rest_api.markdown index 27b4392e1a7..ed5e4ffe03d 100644 --- 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/<timestamp> %} Returns an array of state changes in the past. Each object contains further details for the entities. +The `` 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=` to filter on a single entity + - `end_time=` to choose the end of the period (defaults to 1 day) + ```json [ [