Dashboards - API Documentation
Overview
The Dashboards feature provides customizable analytics boards composed of reusable widgets. It supports private dashboards, selected-user sharing, and optional public dashboard sharing based on feature configuration.
Quick Links
- Dashboards - Create
- Dashboards - Update
- Dashboards - Delete
- Dashboards - Add Widget
- Dashboards - Update Widget
- Dashboards - Remove Widget
- Dashboards - Read
- Dashboards - Read All
- Dashboards - Read Widget
- Dashboards - Read Widget Data
- Dashboards - Read Widget Layout
- Dashboards - Test Widgets
Database Collections
| Collection | Purpose |
|---|---|
countly.dashboards | Stores dashboard definitions, ownership, sharing settings, refresh settings, and widget references. |
countly.widgets | Stores widget configuration and layout metadata used by dashboard pages. |
countly.apps | Provides app metadata used when rendering dashboard widget context. |
countly.members | Provides member data for owner and sharing recipient resolution. |
countly.systemlogs | Stores audit entries for dashboard and widget create/update/delete actions. |
Configuration & Settings
| Setting | Default | Effect |
|---|---|---|
dashboards.sharing_status | true | Controls whether sharing configuration changes are allowed for non-admin contexts in create/update flows. |
Key Capabilities
- Create dashboards from scratch or by duplicating widgets from existing dashboards.
- Share dashboards with selected emails, user groups, or all users (if public sharing is enabled).
- Configure widget-level analytics and refresh behavior.
- Audit dashboard and widget lifecycle events through system logs.
Last Updated
2026-02-17