Documentation

Create your account, set up a tenant, and connect your first data source in minutes.

1. Sign up for a free trial at the registration page.
2. Create a tenant to isolate your team's data.
3. Invite team members and assign roles (Admin, User, or Viewer).
4. Connect Jira or GitLab to start syncing data automatically.

TeamPulse syncs with Jira Cloud using API tokens. Configure your connection to control what data is imported and how often it refreshes.

1. Generate an API token from your Atlassian account settings.
2. Navigate to Settings and enter your Jira URL, email, and API token.
3. Set the sync interval (default: every hour) and lookback period.
4. Optionally add JQL filters to limit which projects or issues are synced.

Build custom dashboards by adding widgets to a flexible grid layout. Each widget visualizes a specific metric or data set.

1. Open any dashboard and click the edit button to enter edit mode.
2. Use the widget picker to add charts, metrics panels, or JQL tables.
3. Drag widgets to rearrange and resize them on the grid.
4. Export your dashboard as JSON to share with teammates or back up your layout.

TeamPulse exposes a REST API documented with OpenAPI 3.1. Use API keys to authenticate programmatic access with fine-grained scope control.

1. Navigate to Settings > API Keys to create a new key.
2. Select scopes to control what the key can access (read, write, admin).
3. Use the key in the X-API-Key header for all API requests.
4. Browse the interactive Swagger UI at /docs for endpoint details.

Connect GitLab to track pipeline performance, merge request throughput, and CI/CD health alongside your Jira metrics.

1. Generate a GitLab personal access token with read_api scope.
2. Enter your GitLab URL and token in Settings > GitLab.
3. Select which projects to sync (or sync all).
4. View pipeline and merge request dashboards under the GitLab section.

Protect your account with multi-factor authentication, manage team roles, and control API key permissions from a single settings page.

1. Enable TOTP-based MFA from Settings > Security.
2. Scan the QR code with your authenticator app and verify with a one-time code.
3. Assign roles to team members: Admin (full access), User (dashboards and data), Viewer (read-only).
4. Review and rotate API keys regularly; revoke any key that is no longer needed.