README Generator

How to Add OSSInsight Stats to Your GitHub Profile README

OSSInsight is an analytics platform powered by TiDB that analyzes GitHub data at massive scale. Its profile cards show detailed developer statistics including monthly PR trends, code review activity, language usage over time, and star history — metrics that go significantly beyond what standard GitHub stats cards provide. This guide covers embedding OSSInsight profile cards in your GitHub README, which requires only your GitHub username and no setup beyond the image URL.

Quick Setup Steps

  1. 1

    Step 1: Find your numeric GitHub user ID by visiting https://api.github.com/users/YOUR_USERNAME and noting the 'id' field.

  2. 2

    Step 2: Visit ossinsight.io/widgets to browse available card types and find the one you want.

  3. 3

    Step 3: Copy the markdown for your chosen card, replacing YOUR_USER_ID with your numeric GitHub user ID.

  4. 4

    Step 4: Add the card markdown to your README.md in a stats or analytics section.

  5. 5

    Step 5: Commit and push. Visit your profile to verify the OSSInsight card renders with your data.

What Is OSSInsight?

OSSInsight (ossinsight.io) is an open-source intelligence platform for GitHub data, built by PingCAP using TiDB's analytical database capabilities. For individual developers, it generates profile cards that visualize: pull request activity trends over the past 12 months, code review contribution history, programming language distribution across all your repositories, top repositories by star growth, and issue/comment activity over time.

Compared to github-readme-stats, OSSInsight's profile cards offer more granular time-series data and trend visualization. They are particularly valuable for developers who want to show activity trends rather than just cumulative totals — a rising PR count or growing review contributions tells a better story than a static lifetime number.

How to Add OSSInsight Stats

OSSInsight provides several card types. The developer overview card:

[![OSSInsight](https://next.ossinsight.io/widgets/official/compose-user-dashboard-stats/thumbnail.png?user_id=YOUR_GITHUB_USER_ID&image_size=auto)](https://next.ossinsight.io/analyze/YOUR_GITHUB_USERNAME)

Note: OSSInsight uses your numeric GitHub user ID (not your username). Find it at https://api.github.com/users/YOUR_USERNAME in the "id" field.

For a collaborative stats card showing language distribution:

[![Lang Stats](https://next.ossinsight.io/widgets/official/compose-user-programming-language-radard/thumbnail.png?user_id=YOUR_USER_ID&image_size=auto)](https://next.ossinsight.io/analyze/YOUR_USERNAME)

OSSInsight's widget gallery at ossinsight.io/widgets lets you browse all available card types and copy the correct markdown.

Customizing OSSInsight Cards

The main customization parameters:

  • image_size: auto (full width), or a pixel value like 300
  • user_id: Your numeric GitHub user ID (required)
  • activity_type: Filter the activity card to a specific type (pr, issue, review, commit)

OSSInsight's analysis pages at ossinsight.io/analyze/YOUR_USERNAME provide a full interactive dashboard that you can link to as a destination for visitors who want to explore your data in more depth. Including this link alongside the card image adds useful context.

For the best visual integration, use OSSInsight cards alongside github-readme-stats cards in a dedicated Analytics or Stats section of your README. OSSInsight's cards are typically wider than stats cards, so placing them full-width below a two-column stats row works well.

Troubleshooting OSSInsight Stats

If the card shows 'No data found' or appears blank, the most likely cause is using the username instead of the numeric user ID. Find your numeric ID by visiting https://api.github.com/users/YOUR_USERNAME and looking for the "id" field — it is a 6-8 digit number.

OSSInsight indexes public GitHub data but may have a processing delay of a few days for new accounts or accounts with limited activity. If you recently joined GitHub or have very few public contributions, the card may show minimal data.

If the card thumbnail is very small or appears at low resolution, add &image_size=auto to the URL. This tells the service to render at the optimal size for the container rather than a fixed thumbnail size.

Frequently Asked Questions

How do I add OSSInsight stats to my GitHub README?

Find your numeric GitHub user ID at api.github.com/users/YOUR_USERNAME (look for the id field), then add the OSSInsight card with that ID. Browse available card types at ossinsight.io/widgets and copy the markdown for the card you want. The card links to your full OSSInsight analytics dashboard.

Is OSSInsight free to use?

Yes. OSSInsight is open source (MIT license) and the hosted service at ossinsight.io is free. The platform is maintained by PingCAP and uses public GitHub data. No API key, account registration, or GitHub connection is needed — only your GitHub user ID.

Why is my OSSInsight card not showing data?

Verify you are using your numeric GitHub user ID (6-8 digits from api.github.com/users/USERNAME), not your username string. New accounts or accounts with limited public activity may show empty cards while OSSInsight indexes their data — this typically resolves within a few days.

What is the difference between OSSInsight and github-readme-stats?

github-readme-stats shows cumulative totals (lifetime commits, stars earned). OSSInsight shows time-series trends — how your activity has changed month by month. OSSInsight is better for demonstrating growth and recent engagement; github-readme-stats is better for showing overall scale of activity.

From Our Blog

Generate Your GitHub Profile README

Generate a GitHub profile README featuring OSSInsight Stats with AI

Try It Free — No Sign Up