https://github.com/hekmon/ha-custstats

Home Assistant custom integration statistics
https://github.com/hekmon/ha-custstats

custom-integration home-assistant installations statistics

Last synced: 18 days ago
JSON representation

Home Assistant custom integration statistics

• Host: GitHub
• URL: https://github.com/hekmon/ha-custstats
• Owner: hekmon
• License: mit
• Created: 2023-04-29T12:30:39.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-28T20:50:32.000Z (about 1 month ago)
• Last Synced: 2024-12-28T21:24:51.308Z (about 1 month ago)
• Topics: custom-integration, home-assistant, installations, statistics
• Language: Python
• Homepage:
• Size: 75.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Home Assistant Custom Integration Statistics

[![Validate with hassfest](https://github.com/hekmon/ha-custstats/actions/workflows/hassfest.yaml/badge.svg)](https://github.com/hekmon/ha-custstats/actions/workflows/hassfest.yaml)

[![Validate with HACS](https://github.com/hekmon/ha-custstats/actions/workflows/hacs.yml/badge.svg)](https://github.com/hekmon/ha-custstats/actions/workflows/hacs.yml)

This integration allows you to track installations statistics for Home Assistant custom integrations.

See [example](https://raw.githubusercontent.com/hekmon/ha-custstats/v1.0.1/res/rtetempo_example.png).

## Prerequisites

In order to work, the integration you want to track installation statistics must exist within the Home Assistant custom integrations [statistics file](https://analytics.home-assistant.io/custom_integrations.json). To be part of this file, custom integration must have been declared to the official [Home Assistant Brands repository](https://github.com/home-assistant/brands).

Also, do not forget users can opt-out from analytics. Therefor, you will only see installation statistics from users who have opt-in for [usage analytics](https://www.home-assistant.io/integrations/analytics/#usage-analytics).

## Installation

### HACS

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=hekmon&repository=ha-custstats&category=integration)

More on HACS [here](https://hacs.xyz/).

### Manually

Download the integration from the [releases](https://github.com/hekmon/ha-custstats/releases) page and decompress the `custom_components/custstats` folder within your Home Assistant configuration directory. You must get: `/path/to/homeassistant/configdir/custom_components/custstats` if your Home Assistant config file is `/path/to/homeassistant/configdir/configuration.yaml`.

## Configuration

Once the integration has been installed and Home Assistant restarted, navigate to the integrations page, select the `Add Integration` button and search for `Custom Integration Stats`. Once the configuration modal opens up, put the integration domain of the integration your want statistics for. If you are unsure of the integration domain, check the [stats file](https://analytics.home-assistant.io/custom_integrations.json) for the integration your are looking for.

If you want to track more than one custom integration, simply repeat the process.