Skip to main content

Documentation

Everything you need to get started with FreshGuard Cloud. From quick setup to advanced configuration, we've got you covered.

Quick Start Guide API Reference

Getting Started

Set up your first data source and monitoring rules in minutes.

Database Connections

Learn how to connect different database types and data warehouses.

API Reference

Complete REST API documentation with examples and SDKs.

Alerting & Notifications

Set up intelligent alerts and integrate with your existing workflows.

Team Management

Manage workspaces, users, and permissions for your team.

Troubleshooting

Common issues and solutions to help you resolve problems quickly.

Quick Start Guide

1

Create Your Account

Sign up for a free FreshGuard account using your GitHub, Google, or Microsoft account. No credit card required for the 14-day trial.

1. Visit localhost:3000
2. Choose your authentication method
3. Create your workspace
2

Connect Your First Data Source

Add a database connection to start monitoring your data freshness. We support PostgreSQL, MySQL, BigQuery, Snowflake, and more.

1. Navigate to "Data Sources" in your dashboard
2. Click "Add Data Source"
3. Enter connection details and test connectivity
3

Create Monitoring Rules

Define freshness thresholds for your critical tables. Set different tolerances for different data sources based on your business needs.

1. Go to "Monitoring Rules"
2. Click "Create Rule"
3. Select table, set freshness threshold, save
4

Configure Alerts

Set up notifications to get alerted when your data goes stale. Choose from email, Slack, or custom webhook integrations.

1. Visit "Settings" → "Notifications"
2. Add your preferred notification channels
3. Configure alert rules and escalation
Start Your Free Trial

Get up and running in under 5 minutes

Popular Resources

The most commonly accessed documentation and guides.

Database Connection Examples

Copy-paste connection strings and configuration examples for all supported databases.

View Examples →

Slack Integration Guide

Step-by-step instructions for setting up Slack notifications with custom formatting.

Setup Slack →

API Quick Start

Get started with our REST API in minutes. Includes authentication and basic operations.

API Guide →

Troubleshooting Common Issues

Solutions for connection timeouts, authentication errors, and other common problems.

Get Help →

Database Connection Examples

Connection strings and configuration examples for all supported databases.

PostgreSQL

postgresql://user:password@host:5432/database?sslmode=require

Supports SSL/TLS encryption and all PostgreSQL 12+ features.

MySQL

mysql://user:password@host:3306/database

Compatible with MySQL 5.7+ and MariaDB.

BigQuery

Configure using a service account JSON key with BigQuery Data Viewer permissions.

Available on Starter plan and above.

Snowflake

Connect using account identifier, warehouse, and role-based authentication.

Available on Professional plan and above.

API Reference

Complete REST API documentation for programmatic access.

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

API Endpoints

  • GET /api/sources - List data sources
  • GET /api/rules - List monitoring rules
  • GET /api/alerts - List alerts
  • POST /api/checks - Trigger manual check

Webhooks

Receive real-time notifications when alerts are triggered. Configure webhook endpoints in Settings → Notifications.

SDKs & Libraries

Official SDKs coming soon. For now, use our REST API directly with any HTTP client.

Alerting & Notifications

Configure alerts to stay informed about data freshness issues.

Slack Integration

Connect FreshGuard to your Slack workspace for instant notifications.

  1. Go to Settings → Notifications → Add Slack
  2. Authorize FreshGuard in your Slack workspace
  3. Select the channel for alerts

Email Alerts

Configure email notifications for team members. Supports digest mode for reduced notification volume.

Custom Webhooks

Send alerts to any HTTP endpoint. Includes customizable payload templates and retry logic.

Escalation Rules

Configure escalation policies to notify additional team members if alerts aren't acknowledged within a specified time.

Team Management

Manage your workspace, users, and permissions.

Workspace Setup

Each workspace is isolated with its own data sources, rules, and team members. Create additional workspaces for different environments or teams.

User Roles

  • Admin - Full access to all settings and configurations
  • Member - Can view dashboards and acknowledge alerts
  • Viewer - Read-only access to dashboards

Permissions

Fine-grained permissions allow you to control access to specific data sources, rules, and settings based on user roles.

SSO Setup

Enterprise plans include SAML 2.0 SSO integration. Contact our sales team to configure SSO for your organization.

Troubleshooting

Common issues and their solutions.

Connection Timeout

Ensure your database allows connections from FreshGuard IP addresses and that firewall rules are configured correctly.

Authentication Failed

Verify your credentials and ensure the user has appropriate permissions on the target database.

Alerts Not Sending

Check your notification settings and ensure the integration (Slack, email) is properly configured and authorized.

Performance Tuning

For large tables, consider adding indexes on timestamp columns. Adjust check intervals based on your data update frequency to balance monitoring coverage with database load.

Frequently Asked Questions

Visit our contact page for additional support or check our community Discord for common questions and answers.

Need more help?

Can't find what you're looking for? Our support team is here to help.

Contact Support Join Community