Documentation

Developer Documentation

Welcome to the SaveYourClient Developer Hub. Learn how to connect your data, train custom AI models, and reduce churn.

Note: You do not need coding skills. Our "Data Studio" handles the mapping for you.

1. How It Works

SaveYourClient uses an "Extract-Load-Predict" pipeline. Your data flows dynamically through our engine to generate actionable insights.

  • 🗄️ Source: Connect PostgreSQL, MongoDB, Oracle, SQL Server, or CSV/SQLite files.
  • ⚙️ Cleaner: Normalizes messy data (dates, currency symbols, missing values).
  • 🧠 AI Model: Random Forest Classifier trained specifically on your dataset to detect hidden patterns.
  • 📊 Dashboard: Displays risk scores, financial impact, and actionable retention strategies.

2. Quickstart Guide

  1. Create an account and log in.
  2. Navigate to the Connections tab.
  3. Add your primary data source (PostgreSQL, MongoDB, etc.).
  4. Go to Data Studio and map raw columns (e.g., monthly_fee) to system fields (e.g., MRR).
  5. Click Build AI & Sync to generate your first report.

3. Connecting PostgreSQL

Supports all standard PostgreSQL instances, including Supabase, Neon, AWS RDS, and self-hosted servers.

postgresql://user:password@host:5432/database_name

Ensure your database allows remote connections from our IP address.

4. Connecting MongoDB (NoSQL)

Supports MongoDB Atlas and standalone servers. Nested JSON documents are automatically flattened for easy mapping (e.g., subscription.plan.price).

mongodb+srv://user:password@cluster.mongodb.net/my_db

5. Connecting Oracle Database

Supports Oracle Cloud, XE, and on-premise instances. Use DSN format or connection string.

localhost:1521/XEPDB1

6. Connecting SQL Server (MSSQL)

Supports Express, Developer, and Enterprise editions. Use the credentials form (Host, Port, User, Pass) for easiest setup.

7. How Scoring Works

Our AI analyzes multiple metrics to calculate a Churn Risk Score (0–100%).

⚠️ High Risk Factors

  • Declining Activity: Login frequency dropping rapidly in the last 30 days (Slope < 0).
  • Support Spikes: High volume of support tickets relative to user tenure.
  • Payment Issues: Late or failed payments recorded.

✅ Protective Factors

  • "Sticky" Features: High usage of core features that drive value.
  • Recent Renewal: Successful contract renewal in last 90 days.
  • Multi-User Activity: Multiple active users in a single account.

8. Strategy Simulator

Identify at-risk clients and use the Strategy Simulator to test potential interventions.

How it works: Adjust variables like "Logins," "Tickets," or "Days Inactive" to see how the AI's risk score changes.

Example: "If I get this client to log in 3 times this week, will their risk score drop below 50%?"

Why use it: Calculate ROI of retention offers (e.g., is a 20% discount worth it if risk drops by only 1%?).

9. Security & Privacy

  • Encryption: TLS 1.3 for transit, AES-256 for data at rest.
  • Isolation: Logical separation of your data from other tenants.
  • Data Minimization: Only metadata necessary for scoring is stored.
  • Hard Delete: You can request permanent deletion of all ingested data anytime via Settings.

10. Contact

Email: dev@saveyourclient.com

Address: 123 Innovation Dr, Tech City, CA 90210