Skip to content

Vaskivskyi/ha-analytics

Repository files navigation

HA Custom Analytics

This repository contains scripts to get the latest Home Assistant Analytics data and process it. The latest data is also available in the docs folder.

The automated data collection in this repository is done each 6 hours.

Usage

Historical Data

The repository now includes historical time series data for each custom integration showing how installation counts changed over time. This data is automatically generated from the raw daily snapshots and is available at:

https://vaskivskyi.github.io/ha-custom-analytics/history/INTEGRATION_NAME/total.json

https://vaskivskyi.github.io/ha-custom-analytics/history/INTEGRATION_NAME/version-VERSION.json

Each file contains a JSON object with date:count mappings, for example:

{
  "2022-10-26": 1000,
  "2022-10-27": 1050,
  "2022-10-28": 1100
}

This data can be used to plot popularity trends and observe the adoption of different integration versions over time.

Shields.io badges

Python script custom_integration_badges.py is used to generate JSON files compatible with Shields badges, showing the number of active installations of custom integrations.

You can use these generated files in the following way (or check the official Shields documentation):

https://img.shields.io/endpoint?url=YOUR_ENDPOINT

If you would like to use already generated data, use the following endpoints:

https://vaskivskyi.github.io/ha-custom-analytics/badges/INTEGRATION_NAME/total.json

https://vaskivskyi.github.io/ha-custom-analytics/badges/INTEGRATION_NAME/version-VERSION.json

Example for a badge of my asusrouter integration:

https://img.shields.io/endpoint?url=https://vaskivskyi.github.io/ha-custom-analytics/badges/asusrouter/total.json

AsusRouter installations

All the styles are available as for any other Shields badges.

AsusRouter installations

Support

If you like the idea of custom HA analytics, you can support me by buying me a coffee.

Buy Me A Coffee

Releases

No releases published

Contributors 4

  •  
  •  
  •  
  •  

Languages