API Overview

Complete reference documentation for the Bilanc Metrics API

Bilanc Metrics API

The Bilanc Metrics API allows you to retrieve various engineering and development metrics from your organization’s data. The API is built using FastAPI and provides endpoints for accessing different types of metrics.

API Endpoint Structure

All metric endpoints follow the pattern: POST /metrics/v2/{metric_type}

Core Concepts

Authentication

All API endpoints require authentication using PropelAuth. Include your authentication token in the request headers.

Authorization: Bearer YOUR_AUTH_TOKEN

See our Authentication guide for more details.

Common Request Parameters

Most API endpoints accept the following common parameters:

Parameter	Type	Description
filters	object	Key-value pairs for filtering the metric data
group_by	array	Fields to group the results by
date_level	string	Time granularity (day, week, month, quarter, year)
aggregation	string	Method to aggregate the metric data
date_field	string	Date field to use for time-based calculations
time_series_data	boolean	Whether to return data formatted for time series visualization
include_previous_period	boolean	Whether to include data from the previous time period

Response Format

API responses are returned in JSON format. The exact structure depends on the requested metric and parameters but generally follows a consistent pattern:

{
  "results": [
    {
      "metric_name": "pull-requests-count",
      "value": 42,
      "group_by": {
        "repository_name": "my-repo"
      }
    }
  ],
  "meta": {
    "filters": {
      "repository_id": "123456"
    },
    "date_range": {
      "start_date": "2023-01-01",
      "end_date": "2023-12-31"
    }
  }
}

Available Metric Categories

Development Metrics

Metrics related to development time and process

Pull Request Metrics

Metrics related to pull requests

Issue Metrics

Metrics related to issues and tickets

Release Metrics

Metrics related to releases

AI Companion Metrics

Metrics related to AI usage and productivity

Multiple Metrics

Request multiple metrics in a single API call

Assistant

Responses are generated using AI and may contain mistakes.