History Stats

The history_stats sensor platform provides quick statistics about another integration or platforms, using data from the history integration.

It can track how long the integration has been in a specific state, in a custom time period.

Examples of what you can track:

  • How long you were at home this week
  • How long the lights were ON yesterday
  • How long you watched TV today


To enable the history statistics sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
  - platform: history_stats
    name: Lamp ON today
    entity_id: light.my_lamp
    state: "on"
    type: time
    start: "{{ today_at() }}"
    end: "{{ now() }}"

Configuration Variables

entity_id string Required

The entity you want to track.

unique_id string (Optional)

An ID that uniquely identifies this entity. Set this to a unique value to allow customization through the UI.

state list | string Required

The states you want to track.

name string (Optional, default: unnamed statistics)

Name displayed on the frontend. Note that it is used by Home Assistant to generate sensor’s object_id so it is advisable to choose a unique one and change name for frontend using customization or via Dashboards.

type string (Optional, default: time)

The type of sensor: time, ratio, or count.

start template (Optional)

When to start the measure (timestamp or datetime).

end template (Optional)

When to stop the measure (timestamp or datetime).

duration time (Optional)

Duration of the measure.

You have to provide exactly 2 of start, end and duration.
You can use template extensions such as now() or as_timestamp() to handle dynamic dates, as shown in the examples below.

Sensor type

Depending on the sensor type you choose, the history_stats integration can show different values:

  • time: The default value, which is the tracked time, in hours
  • ratio: The tracked time divided by the length of your period, as a percentage
  • count: How many times the tracked entity matched the configured state during the time period

Time periods

The history_stats integration will execute a measure within a precise time period. You should always provide 2 of the following :

  • When the period starts (start variable)
  • When the period ends (end variable)
  • How long is the period (duration variable)

As start and end variables can be either datetimes or timestamps, you can configure almost any period you want.


The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below.

# 6 hours
duration: "06:00"
# 1 minute, 30 seconds
duration: "00:01:30"
# 2 hours and 30 minutes
  # supports seconds, minutes, hours, days
  hours: 2
  minutes: 30

If the duration exceeds the number of days of history stored by the recorder integration (purge_keep_days), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if purge_keep_days is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history.

Video tutorial

This video tutorial explains how you can use history stats. It also shows how you can create a daily bar chart graph to visualize things such as occupancy, or how long the lights are on in a particular room.


Here are some examples of periods you could work with, and what to write in your configuration.yaml:

Today: starts at 00:00 of the current day and ends right now.

    start: "{{ today_at() }}"
    end: "{{ now() }}"

Yesterday: ends today at 00:00, lasts 24 hours.

    end: "{{ today_at() }}"
      hours: 24

This morning (6AM - 11AM): starts today at 6, lasts 5 hours.

    start: "{{ today_at('06:00') }}"
      hours: 5

Current week: starts last Monday at 00:00, ends right now.

Here, last Monday is today at 00:00, minus the current weekday (the weekday is 0 on Monday, 6 on Sunday).

    start: "{{ today_at() - timedelta(days=now().weekday()) }}"
    end: "{{ now() }}"

Current month: starts the first day of the current month at 00:00, ends right now.

    start: "{{ today_at().replace(day=1) }}"
    end: "{{ now() }}"

Previous month: starts the first day of the previous month at 00:00, ends the first day of the current month.

    start: "{{ (today_at().replace(day=1) - timedelta(days=1)).replace(day=1) }}"
    end: "{{ today_at().replace(day=1) }}"

Next 4 pm: 24 hours, from the last 4 pm till the next 4 pm. If it hasn’t been 4 pm today, that would be 4 pm yesterday until 4 pm today. If it is already past 4 pm today, it will be 4 pm today until 4 pm tomorrow. When changing the start time, then add or subtract to the 8-hour buffer to match the next midnight.

    end: "{{ (now() + timedelta(hours=8)).replace(hour=16, minute=0, second=0, microsecond=0) }}"
        hours: 24

Last 30 days: ends today at 00:00, lasts 30 days. Easy one.

    end: "{{ today_at() }}"
      days: 30

All your history starts at timestamp = 0, and ends right now.

    start: "{{ 0 }}"
    end: "{{ now() }}"

The /developer-tools/template page of your Home Assistant UI can help you check if the values for start, end or duration are correct. If you want to check if your period is right, just click on your component, the from and to attributes will show the start and end of the period, nicely formatted.