copilot-metrics-api

Name: copilot-metrics-api
Availability: InStock
Author: nicolehaugen

Retrieve and parse NDJSON reports from the GitHub Copilot Metrics API.

Updated Apr 8, 2026

Search Tags:#API #metrics #GitHub #Copilot #NDJSON

Ready to run

npx skills add https://github.com/nicolehaugen/CustomMetricsDashboard --skill copilot-metrics-api

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: copilot-metrics-api
Source: https://github.com/nicolehaugen/CustomMetricsDashboard/tree/main/.github/skills/copilot-metrics-api
Command: npx skills add https://github.com/nicolehaugen/CustomMetricsDashboard --skill copilot-metrics-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill unit simplifies the process of accessing and understanding GitHub Copilot Metrics Reports, offering an easy way to navigate and interpret the data provided by the GitHub Copilot API.

Core Features & Use Cases

API Endpoint Reference: Detailed overview of current and retired endpoints, providing a quick lookup guide for the Copilot Metrics Reports API.
Data Downloading & Parsing: Step-by-step instructions for retrieving and parsing NDJSON reports using both GitHub CLI (gh) and curl.
Authentication & Permissions: Guidelines on verifying and maintaining proper auth scopes for accessing Copilot metrics endpoints.

Quick Start

Retrieve the latest 28-day summary report for your organization's Copilot usage using the GitHub Copilot Metrics API with gh api ....

Frequently Asked Questions about copilot-metrics-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I retrieve GitHub Copilot metrics using the API?▼

Access GitHub Copilot metrics by calling the Copilot Metrics Reports API with the GitHub CLI (`gh api ...`) or `curl` to download and parse NDJSON report files for your organization's usage data.

What are the authentication requirements for the Copilot Metrics API?▼

Accessing the Copilot Metrics API requires proper authentication scopes. You must verify and maintain valid auth permissions via GitHub to successfully retrieve Copilot metrics reports from the endpoints.

What format are GitHub Copilot Metrics Reports downloaded in?▼

GitHub Copilot Metrics Reports are downloaded in NDJSON format. The Skill provides step-by-step instructions to parse these NDJSON files after retrieving them via `gh` or `curl`.

Do I need the GitHub CLI to download Copilot usage data?▼

The GitHub CLI (`gh`) is a dependency for this Skill, but you can also use `curl` to download Copilot usage data. Both methods are supported for retrieving NDJSON reports from the API.

How do I find the correct API endpoint for Copilot metrics?▼

The Skill provides an API endpoint reference detailing current and retired endpoints for the Copilot Metrics Reports API, serving as a quick lookup guide for your Copilot metrics data retrieval operations.