Software Developer Guide
Welcome to the Qrvey Software Developer Guide—your comprehensive resource for embedding enterprise-grade analytics into your applications.
This guide is designed for software developers who are integrating Qrvey's analytics platform into their own applications, whether you're building internal tools, customer-facing SaaS products, or custom data portals. You'll find everything you need to embed interactive analytics, implement robust security, and deliver personalized experiences to your end users.
New to Qrvey? Start with our Quickstart Guide to get up and running in minutes.
What You'll Find Here
This section provides complete technical documentation for embedding and integrating Qrvey into your applications:
Core Integration
Widgets
Qrvey Widgets are embeddable UI components that bring powerful analytics directly into your application. Learn how to:
- Embed dashboards, charts, filters, and reports as reusable components
- Configure widgets for your specific use cases
- Customize styling with CSS variables and theming
- Handle widget lifecycle events and user interactions
- Implement Content Security Policy (CSP) for enhanced security
Key Topics:
- Widget Authentication – Secure your widgets with API keys (dev) and security tokens (production)
- Custom Events – Listen to and respond to widget events in your application
- Custom Tokens – Pass dynamic values to widgets for personalized experiences
- CSS Variables – Brand and style widgets to match your application
Available Widgets:
- Dashboard widget - Enable complete dashboard management for tenant end-users
- Single Panel Widget – Embed individual charts, metrics, or summary panels
- Analytic Suite Widget – Provide a complete analytics workspace
- Pixel-Perfect Reports Widget – Render formatted, printable reports
- Automation Widget – Configure scheduled data exports and automations
- Download Manager Widget – Manage user downloads and data exports
- Dashboard Builder Widget (Legacy) – Allow users to create and edit dashboards within your application
- Dashboard View Widget (Legacy) – Display full interactive dashboards with charts, filters, and navigation
Security & Access Control
Implement enterprise-grade security for your embedded analytics:
- Widget Authentication – Secure widget access with QV Tokens and handle session expiration
- Row-Level Security (RLS) – Control which data records users can see based on their identity and permissions
- Column-Level Security (CLS) – Hide specific columns from users based on their roles
- Multi-tenant Security – Isolate data between tenants in your application
Multi-tenancy & Enterprise Features
Build scalable, multi-tenant analytics solutions:
- Multi-tenant Deployments – Architecture patterns for SaaS applications
- Multi-tenant Dataset Architecture – Design commingled or segregated data models
- End User Personalization – Let users customize their own dashboards and views
Localization & Customization
Deliver tailored experiences for global users:
- Internationalization – Support multiple languages and cultures
- Configuring Dynamic Labels – Translate dataset and column names
- Time Zone Support – Display dates and times in users' local time zones
Integration Workflow
Here's the typical workflow for integrating Qrvey into your application:
- Prepare Your Data – Connect to your data sources and create datasets in Qrvey Composer
- Build Analytics Content – Create dashboards, charts, and reports using Qrvey's visual builders
- Secure Your Integration – Implement authentication and define access controls (RLS/CLS)
- Embed Widgets – Add Qrvey widgets to your application's frontend
- Customize & Brand – Apply your application's look and feel using CSS variables
- Handle Events – Respond to user interactions and widget lifecycle events
- Go Production – Implement security tokens, multi-tenancy, and monitoring
API Documentation
In addition to widgets, Qrvey provides comprehensive REST APIs for programmatic control:
- Authentication API – Generate security tokens for widget authentication
- Dataset Management APIs – Create, update, and manage datasets programmatically
- User Management APIs – Manage users, roles, and multi-tenant organizations
- Content Deployment APIs – Automate content promotion across environments
API Reference: View complete API documentation
Quick Links
Getting Started
- Quickstart Guide – Zero to embedded in 15 minutes
- Introduction to Widgets – Start embedding
- Widget Authentication – Secure your widgets
Security Implementation
Advanced Features
Code Examples
- Codepen Widget Library – Interactive examples
- GitHub Demo Server – Backend reference implementation
Need Help?
- Documentation: Browse articles in this section for detailed guides
- API Reference: qrvey.stoplight.io
- Code Samples: Codepen Collection
- Support: Contact your Qrvey customer success team
Let's get started building powerful embedded analytics experiences!