​
Authentication

The Bilanc Metrics API uses PropelAuth for authentication. All API endpoints require a valid authentication token in the request headers.

​
Obtaining an API Token

You can obtain an API token by:

  1. Logging into your Bilanc dashboard at app.bilanc.co
  2. Navigating to Settings > API Tokens
  3. Creating a new API token with the appropriate permissions

Keep your API tokens secure. Do not share them or commit them to public repositories.

​
Using Your API Token

Include your API token in the Authorization header of your requests:

Authorization: Bearer YOUR_AUTH_TOKEN

​
Example Authenticated Request

Here’s an example of how to authenticate your API requests:

const axios = require('axios');

const API_TOKEN = 'YOUR_AUTH_TOKEN';

async function getMetrics() {
  try {
    const response = await axios.post('https://api.bilanc.co/metrics/v2/pull-requests-count', {
      filters: {
        repository_id: "123456"
      },
      date_level: "month"
    }, {
      headers: {
        'Authorization': `Bearer ${API_TOKEN}`,
        'Content-Type': 'application/json'
      }
    });
    
    return response.data;
  } catch (error) {
    console.error('Error fetching metrics:', error);
  }
}

​
Authentication Errors

If your authentication token is invalid or missing, the API will return a 401 Unauthorized error:

{
  "detail": "Not authenticated"
}

​
Token Expiration

API tokens may be configured to expire after a certain period. When a token expires, you’ll need to generate a new one from the dashboard.

​
Token Permissions

API tokens can be created with different permission levels. Ensure your token has the appropriate permissions for the endpoints you’re trying to access.

For production applications, we recommend creating tokens with the minimum permissions necessary for your use case.

​
Revoking Tokens

You can revoke API tokens at any time from the Bilanc dashboard. Once revoked, a token can no longer be used to authenticate requests.