netlify / netlify/open-api

Feature request: expose usage endpoints in the API

Open
#646 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

What I'd like

It would be great if the API exposed a team's resource usage, so we can read it
programmatically. Ideally covering the same categories shown in Billing → Account
usage insights:

  • Bandwidth
  • Web requests
  • Builds (build minutes)
  • Compute — Serverless Functions and Edge Functions
  • ...and the other usage metrics where applicable

Why

This data lives in the UI today, but there's no documented API for it. Exposing it
would let us build cost dashboards, usage alerts, and feed the numbers into our own
tooling.

Related: #158 .

Thanks for considering! 🙏

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing API specification and the usage metrics shown in Billing → Account usage insights, then read related issue #158. Done means defining and documenting API coverage for the applicable usage categories, including bandwidth, web requests, builds, and compute.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.