Activity

The Activity integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. It depends on the Recorder integration for storing the data. This means that if the Recorder integration is set up to use a database such as MySQL or PostgreSQL, the Activity integration uses that database instead of the default SQLite database.

Viewing activity in the Activity panel

The Activity panel shows recorded changes and events in your home, with the most recent events first. You can narrow it down to the areas, devices, or entities you are interested in.

1. In the sidebar, select Activity.
   • On a wide screen, the Sources pane opens on the left.
   • On a narrow screen, such as a phone, select Sources in the toolbar to open it.
2. Optional: To see only part of your activity, in the Sources pane, select Add target, then select the floors, areas, devices, entities, or labels you want to see.
3. Optional: To narrow down the activity further, use the filters below the targets. The filters also work without a target.
   • Type: shows only activity of entities of the selected types. For example, select the Motion type under Binary sensor to see only motion activity.
   • Integrations: shows only activity of entities that are provided by the selected integrations.
   • Home Assistant remembers your targets and filters the next time you open the panel. To remove all of them, select Clear filter at the top of the pane.
4. To change the time period, select the date range in the toolbar.
   • To move to the previous or next period, select the arrows next to the date range.
5. Optional: In the top right corner, select Menu for more options:
   • Refresh: loads the latest activity.
   • Download data: exports the activity that is currently shown in CSV format.
   • Reset: removes your targets and filters and goes back to the default time period.

Configuration

This integration is by default enabled, unless you’ve disabled or removed the default_config: line from your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. If that is the case, the following example shows you how to enable this integration manually, by adding it to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

# Example configuration.yaml entry
logbook:

Configure filter

To narrow down what you see in the Activity panel, use the Sources pane, as described in Viewing activity in the Activity panel. If you want to hide some entities from the activity for all the users, all the time, you can set up a filter in your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.

By default, the Activity panel uses the same filter as the Recorder integration. To limit which entities are shown in the Activity panel, use the include and exclude parameters.

# Example filter to include specified domains and exclude specified entities
logbook:
  include:
    domains:
      - alarm_control_panel
      - light
    entity_globs:
      - binary_sensor.*_occupancy
  exclude:
    entities:
      - light.kitchen_light

Filters are applied as follows:

1. No filter
   • All entities included
2. Only includes
   • Entity listed in entities include: include
   • Otherwise, entity matches domain include: include
   • Otherwise, entity matches glob include: include
   • Otherwise: exclude
3. Only excludes
   • Entity listed in exclude: exclude
   • Otherwise, entity matches domain exclude: exclude
   • Otherwise, entity matches glob exclude: exclude
   • Otherwise: include
4. Domain and/or glob includes (may also have excludes)
   • Entity listed in entities include: include
   • Otherwise, entity listed in entities exclude: exclude
   • Otherwise, entity matches glob include: include
   • Otherwise, entity matches glob exclude: exclude
   • Otherwise, entity matches domain include: include
   • Otherwise: exclude
5. Domain and/or glob excludes (no domain and/or glob includes)
   • Entity listed in entities include: include
   • Otherwise, entity listed in exclude: exclude
   • Otherwise, entity matches glob exclude: exclude
   • Otherwise, entity matches domain exclude: exclude
   • Otherwise: include
6. No Domain and/or glob includes or excludes
   • Entity listed in entities include: include
   • Otherwise: exclude

The following characters can be used in entity globs:

* - The asterisk represents zero, one, or multiple characters ? - The question mark represents zero or one character

Common filtering examples

To hide the activity of some entities or domains, add the exclude parameter:

# Example of excluding domains and entities from activity tracking (formerly called logbook)
logbook:
  exclude:
    entities:
      - sensor.last_boot
      - sensor.date
    entity_globs:
      - sensor.weather_*
    domains:
      - sun

To see only the activity of specific entities or domains, use the include parameter:

# Example to show how to only track the activity of the listed domains and entities
logbook:
  include:
    domains:
      - sensor
      - switch
      - media_player

You can also use the include list and filter out some entities or domains with an exclude list. Usually, this makes sense if you define domains on the include side and filter out some specific entities.

# Example of combining include and exclude configurations for activity tracking
logbook:
  include:
    domains:
      - sensor
      - switch
      - media_player
  exclude:
    entities:
      - sensor.last_boot
      - sensor.date
    entity_globs:
      - sensor.weather_*

Hiding entities and domains

If you have sensor.date to show the current date in the UI, but you do not want to see its change every day in the Activity panel, you can hide it. To hide entities, add them to the exclude > entities list.

To hide all activity of a whole domain, add it to the exclude > domains list. For example, if you use the sun domain only in automations, you might not want to see every sunrise and sunset in the Activity panel.

Hidden entities still take up space in the database. To save space, exclude them in the Recorder integration instead.

Custom entries

To add your own entries to the Activity panel, use the Log activity action in an automation or a script.

List of actions

The Activity integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.

• Log activity (logbook.log) Adds a custom entry to the Activity panel.

For an overview of every action across all integrations, see the actions reference.