API Reference

GitProductivity provides a REST API for programmatic access to your data. This reference documents all available endpoints.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.gitproductivity.com/v1

Rate Limits

| Plan | Requests/minute | Requests/day | |------|-----------------|--------------| | Free | 60 | 1,000 | | Pro | 300 | 10,000 | | Enterprise | 1,000 | Unlimited |

Endpoints

Repositories

Response:

{
  "data": [
    {
      "id": "repo_123",
      "name": "my-project",
      "provider": "github",
      "language": "TypeScript",
      "stars": 150,
      "last_synced": "2026-03-19T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20
  }
}

Developers

Query Parameters:

| Parameter | Type | Description | |-----------|------|-------------| | page | integer | Page number (default: 1) | | per_page | integer | Items per page (default: 20, max: 100) | | sort | string | Sort field (workdays, commits, prs) | | order | string | Sort order (asc, desc) |

Response:

{
  "id": "dev_456",
  "name": "John Doe",
  "email": "john@example.com",
  "avatar_url": "https://...",
  "stats": {
    "workdays": 45.2,
    "commits": 234,
    "prs_merged": 67,
    "reviews_given": 89,
    "ai_boost": 1.3
  },
  "period": {
    "start": "2026-01-01",
    "end": "2026-03-19"
  }
}

Analytics

Query Parameters:

| Parameter | Type | Description | |-----------|------|-------------| | start_date | string | Start date (YYYY-MM-DD) | | end_date | string | End date (YYYY-MM-DD) | | repository_ids | string | Comma-separated repository IDs |

Webhooks

Request Body:

{
  "url": "https://your-server.com/webhook",
  "events": ["developer.added", "repository.connected"],
  "secret": "your_webhook_secret"
}

Error Responses

All errors return standard HTTP status codes with JSON response bodies:

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": []
  }
}

Common Error Codes

| Code | Status | Description | |------|--------|-------------| | invalid_request | 400 | Malformed request | | unauthorized | 401 | Invalid or missing API key | | forbidden | 403 | Insufficient permissions | | not_found | 404 | Resource not found | | rate_limited | 429 | Rate limit exceeded |

SDKs

Official SDKs are available for:

• JavaScript/TypeScript: npm install @gitproductivity/sdk
• Python: pip install gitproductivity

Example usage:

import { GitProductivity } from '@gitproductivity/sdk';

const client = new GitProductivity('YOUR_API_KEY');
const developers = await client.developers.list();

Next Steps

• Configure Webhooks for real-time notifications
• Deploy Self-Hosted for on-premise solutions