Skip to content

Bandum API (runs on your machine): metrics ​

Delivery metrics for PMs and Ryoma

This page is generated from openapi.yaml by npm run gen, so do not edit it by hand. Authentication is described on the overview page.

GET/v1/metrics

Delivery metrics per task, summarized by repo and milestone

Without repo: every tracked repo. Ryoma joins key (GH-n) and repo with the cost per forge.issue.

Parameters ​

NameInTypeRequiredDescription
repoquerystringowner/repo
milestonequerystringMilestone name (requires repo)

Responses ​

CodeDescriptionType
200Metricsapplication/json · object
400Invalid parameterapplication/problem+json · object
401Not signed inapplication/problem+json · object
404Repo, milestone, task or organization not foundapplication/problem+json · object

Example response ​

json
{
  "repo": "string",
  "milestone": "string",
  "summary": {
    "tasks": 0,
    "tested": 0,
    "approved": 0,
    "done": 0,
    "rejections": 0
  },
  "tasks": [
    {
      "repo": "string",
      "number": 0,
      "key": "string",
      "title": "string",
      "status": "todo",
      "level": "S",
      "runs": 0,
      "rejections": 0
    }
  ]
}

Call with curl ​

bash
curl "http://localhost:8070/v1/metrics" \
  -H "Authorization: Bearer $BANDUM_LOCAL_KEY"