API Reference (Work in Progress)

The Pulzen API provides comprehensive access to development data and metrics through a set of RESTful endpoints. This documentation covers all available endpoints for retrieving information about workflows, users, teams, repositories, pull requests, issues, deployments, commits, and code reviews.

Each endpoint supports optional filtering by date ranges and data providers, allowing you to customize the data returned based on your specific needs. All endpoints return data in Server-Sent Events (SSE) format for real-time streaming of results.

What are Server-Sent Events (SSE)?

Server-Sent Events (SSE) is a web standard that enables real-time data streaming from server to client over HTTP. Unlike traditional REST APIs that return complete JSON responses, SSE allows for continuous data flow as it becomes available.

Key SSE Characteristics:
  • Real-time streaming: Data flows continuously as it's processed
  • Persistent connection: Single HTTP connection remains open
  • Incremental data: Receive data in chunks rather than all at once
  • Automatic reconnection: Built-in retry mechanism if connection drops
  • Event-driven: Each piece of data is sent as a separate event

Base URL

All API endpoints are relative to the following base URL. The URL below is used as an example throughout this documentation, but you must replace it with your actual API base URL when making requests:

https://api.pulzen.com/v1

Authentication

All requests require authentication via API tokens.

Commits

GET /api/dashboard/commits

Retrieves all code commits and version control activities across your repositories. This endpoint provides detailed information about code changes, development patterns, and contribution metrics.

Parameters & Response Details

Query Parameters:

  • dateStart (optional): Start date to filter commits (format: YYYY-MM-DD)
  • dateEnd (optional): End date to filter commits (format: YYYY-MM-DD)
  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing commit data including:

  • Commit hash and message
  • Author and committer information
  • Repository and branch details
  • Files changed and line modifications
  • Commit timestamp and timezone
  • Parent commits and merge information
  • Associated pull requests and issues
  • Code review status and approval
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/commits" \
  -H "Authorization: Bearer {token}" \
  -d "dateStart=2024-01-01" \
  -d "dateEnd=2024-12-31" \
  -d "provider=GITHUB"

Pull Requests

GET /api/dashboard/pull-requests

Retrieves all pull requests and merge requests across your repositories. This endpoint provides detailed information about code review processes, collaboration patterns, and code quality metrics.

Parameters & Response Details

Query Parameters:

  • dateStart (optional): Start date to filter pull requests (format: YYYY-MM-DD)
  • dateEnd (optional): End date to filter pull requests (format: YYYY-MM-DD)
  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing pull request data including:

  • Pull request ID and title
  • Author and assignees
  • Source and target branches
  • Status (open, closed, merged, draft)
  • Review status and approval count
  • Comments and discussion threads
  • Files changed and line additions/deletions
  • Merge information and timestamps
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/pull-requests" \
  -H "Authorization: Bearer {token}" \
  -d "dateStart=2024-01-01" \
  -d "dateEnd=2024-12-31" \
  -d "provider=GITHUB"

Code Reviews

GET /api/dashboard/code-reviews

Retrieves all code review activities and feedback across your repositories. This endpoint provides insights into code quality processes, review patterns, and collaboration effectiveness.

Parameters & Response Details

Query Parameters:

  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing code review data including:

  • Review ID and type (pull request review, inline comments)
  • Reviewer and reviewee information
  • Review status (approved, changes requested, commented)
  • Review comments and suggestions
  • Associated pull request and commit
  • Review timestamp and duration
  • Code coverage and quality metrics
  • Review feedback and resolution status
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/code-reviews" \
  -H "Authorization: Bearer {token}" \
  -d "provider=GITHUB"

Workflows

GET /api/dashboard/workflows

Retrieves all CI/CD workflows and pipeline executions across your connected repositories. This endpoint provides comprehensive information about build processes, deployment pipelines, and automation workflows.

Parameters & Response Details

Query Parameters:

  • dateStart (optional): Start date to filter workflows (format: YYYY-MM-DD)
  • dateEnd (optional): End date to filter workflows (format: YYYY-MM-DD)
  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing workflow data including:

  • Workflow name and ID
  • Execution status (success, failed, running, cancelled)
  • Duration and timestamps
  • Trigger information (push, pull request, manual)
  • Associated repository and branch
  • Build artifacts and deployment details
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/workflows" \
  -H "Authorization: Bearer {token}" \
  -d "dateStart=2024-01-01" \
  -d "dateEnd=2024-12-31" \
  -d "provider=GITHUB"

Deploys

GET /api/dashboard/deploys

Retrieves all deployment activities and releases across your applications. This endpoint provides comprehensive information about deployment pipelines, release management, and production deployments.

Parameters & Response Details

Query Parameters:

  • dateStart (optional): Start date to filter deploys (format: YYYY-MM-DD)
  • dateEnd (optional): End date to filter deploys (format: YYYY-MM-DD)
  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing deploy data including:

  • Deployment ID and name
  • Environment (staging, production, development)
  • Status (success, failed, in progress, cancelled)
  • Deployment strategy and rollback information
  • Associated commit and branch
  • Deployment duration and timestamps
  • Infrastructure details and resource usage
  • Health checks and monitoring data
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/deploys" \
  -H "Authorization: Bearer {token}" \
  -d "dateStart=2024-01-01" \
  -d "dateEnd=2024-12-31" \
  -d "provider=GITHUB"

Issues

GET /api/dashboard/issues

Retrieves all issues, bugs, and feature requests across your repositories and project management tools. This endpoint provides insights into project management, bug tracking, and development priorities.

Parameters & Response Details

Query Parameters:

  • dateStart (optional): Start date to filter issues (format: YYYY-MM-DD)
  • dateEnd (optional): End date to filter issues (format: YYYY-MM-DD)
  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing issue data including:

  • Issue ID and title
  • Description and labels/tags
  • Priority and severity levels
  • Status (open, closed, in progress, resolved)
  • Assignee and reporter information
  • Comments and activity history
  • Milestone and sprint associations
  • Time tracking and resolution metrics
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/issues" \
  -H "Authorization: Bearer {token}" \
  -d "dateStart=2024-01-01" \
  -d "dateEnd=2024-12-31" \
  -d "provider=GITHUB"

Repositories

GET /api/dashboard/repositories

Retrieves all code repositories and projects across your connected platforms. This endpoint provides comprehensive information about codebases, their structure, and development activity.

Parameters & Response Details

Query Parameters:

  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing repository data including:

  • Repository ID and name
  • Description and topics/tags
  • Visibility settings (public/private)
  • Default branch and language statistics
  • Owner and organization information
  • Clone URLs and webhook configurations
  • Repository size and activity metrics
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/repositories" \
  -H "Authorization: Bearer {token}" \
  -d "provider=GITHUB"

Users

GET /api/dashboard/users

Retrieves all contributors and team members across your connected platforms. This endpoint provides detailed information about developers, their roles, and activity patterns.

Parameters & Response Details

Query Parameters:

  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing user data including:

  • User ID and username
  • Email and profile information
  • Role and permissions
  • Activity metrics and contribution statistics
  • Team associations
  • Last activity timestamps
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/users" \
  -H "Authorization: Bearer {token}" \
  -d "provider=GITHUB"

Teams

GET /api/dashboard/teams

Retrieves all teams and organizational structures across your connected platforms. This endpoint provides insights into team composition, collaboration patterns, and organizational hierarchy.

Parameters & Response Details

Query Parameters:

  • provider (optional): Data provider (GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS, ALL, JIRA, COPILOT, MSTEAMS)

Response: SSE event stream containing team data including:

  • Team ID and name
  • Team description and purpose
  • Member count and composition
  • Team lead and admin information
  • Associated repositories and projects
  • Team performance metrics
Example
curl -G "https://api.pulzen.com/v1/api/dashboard/teams" \
  -H "Authorization: Bearer {token}" \
  -d "provider=GITHUB"