badges / badges/shields

Badge Request Grafana Dashboard Badge

Open
#10,670 2 comments 0 reactions 0 assignees View on GitHub
service-badge
Dominant language
JavaScript
Stars
27.2k
Forks
5.6k
Avg merge
1d 8h
Merged PRs (30d)
46

Description

### 📋 Description

The feature request is for the addition of a Badge for Grafana Dashboard Metrics that displays detailed statistics about the dashboard's popularity, including its download count, revision, and usage data. These badges will be customizable with text and color and can optionally display a logo.

Service: Grafana Dashboard
Information Displayed: Download count of the Grafana dashboard, badge color based on popularity, and revision count.
Example: "Downloads | 1234" or "Revision | 5" as dynamic values.

### 🔗 Data

- Public API: Grafana offers public API endpoints to retrieve dashboard information.
- Authentication: The API does not require authentication for public dashboards
- Data Source: The data is retrieved via scraping the Grafana dashboard pages, using the dashboard ID as a key.

### 🎤 Motivation

This feature will help users to display the popularity and version of their Grafana dashboards through easily accessible and customizable badges. By generating these badges, dashboard creators can share and visualize the success of their dashboards with others, creating more engagement in the community.

Use Case: Users want to show how popular their dashboards are (download count) or display the most recent version (revision). This would be used by dashboard creators to show the current download count of their Grafana dashboard in GitHub README files, blogs, or community forums.

I have already worked on this project with the [**Grafana Dashboard Badge**](https://github.com/czantoine/Grafana-Dashboard-Badge) repository, which allows generating badges to display these metrics in a simple way.

![Download Badge](https://grafana-dashboard-badge.netlify.app/.netlify/functions/api/badge?id_dashboard=21378&logo=true)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked Grafana Dashboard Badge repository and the public Grafana API or scraping approach described in the issue. Define the supported dashboard metrics and badge options; done means download or revision values render with customizable text and color, plus an optional logo.

Written by the indexing model from the issue text.

Assessment

Tech stack
grafana, javascript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.