# Lark Dashboard SDK Documentation
This directory contains comprehensive documentation for the Lark Dashboard SDK, including research findings, API limitations, and implementation guides.
## Documents
### 📊 [APAAS_API_RESEARCH.md](./APAAS_API_RESEARCH.md)
**Comprehensive Research Report on aPaaS Dashboard API**
The definitive guide to Lark aPaaS capabilities and limitations. This 21,500-word research report covers:
- ✅ Complete analysis of Lark Base (Bitable) API
- ✅ Supported vs. unsupported view types
- ✅ Dashboard creation limitations (NOT available via API)
- ✅ Three alternative implementation approaches
- ✅ Code examples and implementation guides
- ✅ API endpoint reference
- ✅ Future possibilities and workarounds
**Read this if:** You want to understand why dashboards can't be created programmatically and what the alternatives are.
**Time to read:** 30 minutes
**Key Finding:**
```
❌ Dashboard views CANNOT be created via API
✅ Workaround: Create manually in UI, manage data via API
```
---
### 🚀 [QUICK_START_APAAS.md](./QUICK_START_APAAS.md)
**5-Minute Quick Start Guide**
Fast-track guide to setting up Lark dashboards with this SDK.
**Contents:**
- ⚡ 5-minute setup walkthrough
- 🎯 Three implementation approaches (Easy, Medium, Hard)
- 💡 Complete code examples
- ❓ FAQ section
- 🔗 API reference quick lookup
**Read this if:** You want to get started immediately without reading the full research report.
**Time to read:** 5 minutes
**Quick Example:**
```typescript
// 1. Create tables via API (1 min)
const table = await client.tables.create({...});
// 2. Create dashboard manually in UI (3 min)
// 3. Add data via API (30 sec)
await dashboardMgr.updateDashboardData(table.table_id, records);
```
---
### ⚠️ [API_LIMITATIONS.md](./API_LIMITATIONS.md)
**Known API Limitations and Workarounds**
Detailed documentation of Lark API limitations discovered during development.
**Contents:**
- Bitable view type restrictions
- Rate limiting information
- Field type constraints
- Batch operation limits
**Read this if:** You're encountering errors or want to understand API boundaries.
---
### 📝 [SENTIMENT_DASHBOARD_MANUAL_GUIDE.md](./SENTIMENT_DASHBOARD_MANUAL_GUIDE.md)
**Manual Dashboard Creation Guide**
Step-by-step guide for creating dashboards manually in the Lark UI.
**Contents:**
- Dashboard creation walkthrough
- Chart configuration examples
- Filter setup instructions
- Best practices
**Read this if:** You need help creating dashboards in the Lark UI.
---
## Research Summary
### What We Discovered
After extensive research across multiple sources:
- ✅ Lark Developer Documentation
- ✅ Feishu Open Platform
- ✅ GitHub repositories (official SDKs)
- ✅ Community resources
- ✅ API Explorer testing
We confirmed that:
1. **Dashboard views cannot be created programmatically**
- The `/open-apis/bitable/v1/apps/:app_token/tables/:table_id/views` endpoint only supports: `grid`, `kanban`, `gallery`, `gantt`, `form`
- `dashboard` is NOT a supported view type
2. **No public aPaaS page/component API exists**
- No endpoints for creating custom pages
- No API for adding widgets/blocks to aPaaS apps
- Component Builder docs are limited
3. **Workarounds are available**
- Manual dashboard creation + API data management (Best)
- Lark Docs with embedded charts
- Custom Base extensions with VChart
### Recommended Approach
**For 99% of use cases: Approach A (Manual Dashboard + API Data)**
```typescript
// ✅ What works via API
const table = await client.tables.create({...});
await client.records.batchCreate(table.table_id, data);
// ❌ What doesn't work via API
await client.views.create(table.table_id, {
view_type: 'dashboard' // ERROR: Not supported
});
// ✅ Solution
// 1. Create dashboard manually in Lark UI (3 min)
// 2. Dashboard auto-updates when you add data via API
```
---
## Document Index
| Document | Purpose | Length | Difficulty |
|----------|---------|--------|------------|
| [APAAS_API_RESEARCH.md](./APAAS_API_RESEARCH.md) | Complete research report | 21,500 words | Advanced |
| [QUICK_START_APAAS.md](./QUICK_START_APAAS.md) | Quick start guide | 3,000 words | Beginner |
| [API_LIMITATIONS.md](./API_LIMITATIONS.md) | API constraints | 1,500 words | Intermediate |
| [SENTIMENT_DASHBOARD_MANUAL_GUIDE.md](./SENTIMENT_DASHBOARD_MANUAL_GUIDE.md) | Manual setup guide | 2,000 words | Beginner |
---
## Quick Links
### Official Documentation
- [Lark Developer Portal](https://open.larksuite.com/)
- [Lark Base API Overview](https://open.larksuite.com/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview)
- [Create View API](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create)
- [Lark Base JS SDK](https://lark-base-team.github.io/js-sdk-docs/en/)
### Community Resources
- [Lark Base Team GitHub](https://github.com/Lark-Base-Team)
- [Awesome-BaseScript](https://github.com/ConnectAI-E/Awesome-BaseScript)
- [Lark OpenAPI MCP](https://github.com/larksuite/lark-openapi-mcp)
### This Project
- [Main README](../README.md)
- [Examples](../examples/)
- [Source Code](../src/)
- [GitHub Issues](https://github.com/hypelab/hype-dash/issues)
---
## Support
### Getting Help
1. **Quick questions:** Check [QUICK_START_APAAS.md](./QUICK_START_APAAS.md) FAQ section
2. **API errors:** Review [API_LIMITATIONS.md](./API_LIMITATIONS.md)
3. **Understanding limitations:** Read [APAAS_API_RESEARCH.md](./APAAS_API_RESEARCH.md)
4. **Bug reports:** [Open an issue](https://github.com/hypelab/hype-dash/issues)
### Contact
- **Project Issues:** https://github.com/hypelab/hype-dash/issues
- **Lark Support:** https://www.larksuite.com/hc/en-US/
---
## Version History
- **v1.0.0** (2025-12-09): Initial documentation release
- Complete aPaaS API research
- Three implementation approaches documented
- Code examples and guides
---
**Last Updated:** December 9, 2025
