DatomniX Documentation Index

Developed by ETK Technologies

Complete documentation for the DatomniX Multi-Tenant Attribution & Analytics Platform.

---

🚀 Platform Status

Version: 1.0.0 (Production Ready)
Last Updated: November 9, 2025
Status: ✅ Fully Operational

---

📚 Documentation Overview

All documentation is organized in the docs/ folder and is also served dynamically via the API at /docs.

---

🎯 Quick Navigation

New User? Start Here:

1. README - Platform overview and quick start
2. Quick Start Guide - Get running in 5 minutes
3. Onboarding Guide - Complete client walkthrough

Developer? Go Here:

1. Quick Start Guide - Local setup
2. Architecture - System design
3. API Reference - Complete API docs

DevOps? Check These:

1. Deployment Guide - Production deployment
2. Setup Guide - Configuration
3. Architecture - Infrastructure

---

📖 Core Documentation

1. README

Complete platform overview
For: Everyone - start here

Topics:

• Platform features and benefits


• Quick start (3 commands)


• Architecture overview


• Tech stack


• Use cases and roadmap


• Getting started guide

2. Quick Start Guide


Get DatomniX running in 5 minutes
For: Developers and new users

Topics:


• 3-step installation


• Test accounts and credentials


• First steps after login


• Useful commands


• Troubleshooting


• Next steps

3. Architecture Documentation


Deep dive into system design
For: Developers and architects

Topics:


• Multi-tenant architecture


• Component structure


• Data flow diagrams


• Event processing pipeline


• Attribution engine logic


• Database design


• Performance optimizations


• Security architecture


• Scalability considerations

4. API Reference


Complete API endpoint documentation
For: Frontend developers and API consumers

Topics:


• Authentication (register, login, JWT)


• Workspace and brand management


• Event tracking endpoints


• Attribution queries (5 models)


• Reporting endpoints


• Integration configuration


• Rate limiting


• Code examples (JavaScript, Python, cURL)

5. S2S Integration Guide 🔥 NEW


Server-to-Server tracking with custom product categorization
For: Backend developers, e-commerce integrations, SaaS platforms

Topics:


• Complete S2S API usage with code examples (Node.js, Python, PHP, cURL)


• Custom product categorization - Define YOUR own taxonomy for ANY industry


• Industry-specific examples (E-Commerce, SaaS, Telehealth, B2B, Education, Real Estate)


• Batch event ingestion (100 events/request)


• Best practices for idempotent tracking


• Error handling and retry logic


• Testing and debugging

Why It's Important:
Shows you how to send events with YOUR custom product categories - no hardcoded restrictions! Perfect for any business type.

6. Attribution Models


Guide to all attribution models
For: Marketing teams and analysts

Topics:


• Last-click attribution


• First-click attribution


• Linear attribution


• Time-decay attribution


• Position-based attribution (U-shaped)


• Model comparison API


• When to use each model


• Best practices

7. Onboarding Guide


Complete client onboarding walkthrough
For: New clients and team members

Topics:


• Account creation


• Brand configuration


• Tracking pixel installation


• UTM campaign tracking


• Platform integrations (Meta, TikTok, GA4)


• Team management


• Troubleshooting


• GDPR compliance

8. Setup Guide - Multi-Tenant


Complete setup for the multi-tenant system
For: Developers and system administrators

Topics:


• Environment configuration


• Database migrations


• User authentication setup


• RBAC configuration


• Workspace and brand setup


• Testing credentials


• Production checklist

9. Deployment Guide


Production deployment instructions
For: DevOps engineers

Topics:


• Railway deployment (API + Database)


• Vercel deployment (Dashboard)


• Environment variables


• DNS and SSL configuration


• Docker deployment


• Monitoring and logging


• Backup strategies


• Security best practices

10. Roles & Permissions


RBAC system documentation
For: Administrators and team managers

Topics:


• Role hierarchy (Super Admin, Owner, Admin, Member)


• Permission matrix


• Workspace access control


• Brand-level permissions


• Team management


• Security considerations

11. Super Admin Guide


Platform administration
For: ETK Technologies staff

Topics:


• Super admin capabilities


• Workspace management


• User management


• System monitoring


• Platform configuration


• Support workflows

12. SaaS Transformation Progress


Implementation status and features
For: Development team and stakeholders

Topics:


• Completed features


• Current capabilities


• Implementation details


• Database schema


• Future enhancements

13. Frontend-Backend Integration


Integration documentation
For: Full-stack developers

Topics:


• API integration patterns


• Authentication flow


• State management


• Data fetching strategies


• Error handling


• Best practices

---

🚂 Railway Deployment Documentation

Swagger Railway Configuration


Automatic URL configuration for Railway deployments
For: DevOps engineers and developers

Topics:


• Automatic Railway URL detection


• Dynamic Swagger server configuration


• Environment variable usage


• Custom domain support


• Verification and troubleshooting

Additional Railway Resources

• Railway Environment Variables - Complete variable reference


• Railway Deployment Guide - Step-by-step deployment


• Railway Database Setup - PostgreSQL configuration


• Railway Health Check - Health endpoint setup


• Railway Variables Table - Quick reference table

---

🗺️ Documentation by Role

🎓 For End Users

Getting Started:
1. Read README for overview
2. Follow Onboarding Guide
3. Install tracking pixel
4. Connect integrations
5. View your data!

Key Resources:


• Onboarding Guide


• Attribution Models


• Roles & Permissions

👨‍💻 For Developers

Getting Started:
1. Read Quick Start Guide
2. Set up local environment
3. Review Architecture
4. Study API Reference
5. Start building!

Key Resources:


• Quick Start Guide


• Architecture


• API Reference


• Setup Guide

🚀 For DevOps

Getting Started:
1. Read Deployment Guide
2. Set up production environment
3. Configure monitoring
4. Implement backups
5. Go live!

Key Resources:


• Deployment Guide


• Swagger Railway Configuration


• Railway Environment Variables


• Architecture


• Setup Guide

🏢 For Administrators

Getting Started:
1. Read Roles & Permissions
2. Create workspace and brands
3. Invite team members
4. Configure integrations
5. Manage your team!

Key Resources:


• Roles & Permissions


• Onboarding Guide


• Super Admin Guide (ETK only)

🔧 For ETK Technologies Staff

Super Admin Resources:
1. Super Admin Guide
2. SaaS Transformation Progress
3. Architecture
4. Deployment Guide

---

🔗 External Resources

API Access



• Swagger UI (Local): http://localhost:3001/api/docs


• Documentation Portal (Local): http://localhost:3001/docs


• Health Check: http://localhost:3001/api/v1/health

Learning Resources



• NestJS: https://docs.nestjs.com


• Next.js: https://nextjs.org/docs


• Prisma: https://www.prisma.io/docs


• Redis Streams: https://redis.io/docs/data-types/streams/


• Tailwind CSS: https://tailwindcss.com/docs

---

✨ What's New

Version 1.0.0 (November 2025) - Production Ready! 🎉

Major Features:


• ✅ Complete multi-tenant SaaS architecture


• ✅ 5 attribution models (last-click, first-click, linear, time-decay, position-based)


• ✅ Platform integrations (Meta CAPI, TikTok, GA4, Shopify, WooCommerce)


• ✅ 30x faster queue processing (3 parallel consumers)


• ✅ Real-time queue monitoring


• ✅ Beautiful dashboard with dark mode


• ✅ Complete RBAC system


• ✅ Comprehensive documentation


• ✅ Production-ready deployment

Performance:


• 30x faster event processing


• 3 parallel consumers


• 100 events per batch


• Real-time queue indicator


• Optimized database queries

Integrations:


• Meta Conversions API (CAPI)


• TikTok Events API


• Google Analytics 4


• Shopify webhooks


• WooCommerce webhooks


• Custom HTTP webhooks

---

🗺️ Development Roadmap

✅ Completed



• Multi-tenant workspace system


• User authentication with JWT


• Brand management


• Event ingestion (pixel + API)


• 5 attribution models


• Platform integrations (6+)


• Real-time analytics dashboard


• Queue optimization (30x)


• Complete documentation

🚧 In Progress



• Advanced funnel visualization


• Real-time updates (WebSockets)


• Comprehensive test suite


• Super admin UI panel

📋 Planned (v1.1)



• Custom attribution models (ML)


• Customer lifetime value (CLV)


• Advanced cohort analysis


• Mobile app


• White-label capabilities


• View-through attribution


• Cross-device resolution

🔮 Future (v2.0)



• AI-powered insights


• Predictive analytics


• Real-time bidding optimization


• A/B testing framework


• Multi-language support


• Enterprise SSO

---

📊 Platform Statistics

• API Endpoints: 50+


• Attribution Models: 5


• Platform Integrations: 6


• Database Tables: 15+


• React Components: 50+


• Documentation Pages: 12


• Lines of Code: 50,000+


• Test Accounts: Ready to use


• Production Status: ✅ Ready

---

🎓 Learning Path

Beginner (0-1 hour)


1. Read README overview (10 min)
2. Follow Quick Start Guide (20 min)
3. Explore the dashboard (30 min)

Goal: Understand what DatomniX does and see it running

Intermediate (1-3 hours)


1. Read Architecture (30 min)
2. Study API Reference (45 min)
3. Install tracking pixel (15 min)
4. Send test events (15 min)
5. Connect an integration (45 min)

Goal: Understand how it works and integrate it

Advanced (3+ hours)


1. Read Setup Guide (30 min)
2. Review Deployment Guide (45 min)
3. Study Attribution Models (30 min)
4. Deploy to production (2+ hours)
5. Configure monitoring and backups (1+ hour)

Goal: Deploy and manage in production

Expert (Ongoing)


1. Extend integration framework
2. Add custom attribution models
3. Build custom dashboards
4. Contribute to codebase
5. Optimize performance

Goal: Customize and extend the platform

---

📝 Documentation Standards

Writing Guidelines



• Use clear, concise language


• Include code examples


• Add diagrams where helpful


• Keep information up to date


• Test all commands before documenting

Code Examples



• Provide working examples


• Include expected output


• Show error handling


• Use realistic data


• Add comments for clarity

Maintenance



• Update after feature changes


• Review quarterly


• Fix broken links


• Update screenshots


• Verify command accuracy

---

🆘 Getting Help

Documentation



• Local API Docs: http://localhost:3001/docs


• Swagger UI: http://localhost:3001/api/docs


• This Index: Starting point for all docs

Support Channels



• Email: support@etk.com


• Issues: GitHub Issues


• Website: https://etk.com

Before Asking for Help


1. ✅ Check this documentation index
2. ✅ Read relevant guide
3. ✅ Try the troubleshooting section
4. ✅ Check API health endpoint
5. ✅ Review error messages
6. ✅ Search existing issues

---

🔍 Search Tips

Finding Documentation




# Search all docs
grep -r "your search term" docs/

# Search specific file
grep "authentication" docs/API_REFERENCE.md

Common Searches



• "authentication" → API_REFERENCE.md, Setup Guide


• "attribution models" → ATTRIBUTION_MODELS.md


• "deployment" → DEPLOYMENT.md


• "roles" → ROLES_AND_PERMISSIONS.md


• "quickstart" → QUICKSTART.md


• "integrations" → Onboarding Guide, API Reference

---

💡 Pro Tips

1. Start with Quick Start - Get hands-on first
2. Bookmark Swagger UI - Essential for API testing
3. Read Architecture - Understand the system
4. Use Test Accounts - Safe experimentation
5. Check Health First - Verify system is running
6. Join Documentation - Contribute improvements

---

📞 Contact

ETK Technologies


• Email: support@etk.com


• Website: https://etk.com


• Enterprise: enterprise@etk.com

---

📄 Documentation Versions

• Current: 1.0.0 (Production)


• Previous: 0.3.0 (Beta)


• Next: 1.1.0 (Planned)

---

This documentation is maintained by ETK Technologies and updated regularly.

Last Major Update: November 9, 2025
Next Review: December 2025
Status: ✅ Current and Complete

---

Built with ❤️ by ETK Technologies