Skip to content

Dashboards

A file in dashboards/ is one Dashboard for one scope, rendered for people, native clients and agents.

A file in dashboards/ is one Dashboard for one scope: the Startup, a Team, a Role, or where they meet.

  • dashboards/
  • renewals.mdxthe success manager's Dashboard

Reference

MDX: frontmatter is the scope, and the body is Components with literal props.

KeyTypeHolds
scopeStartup, Team or Role pathWhose Dashboard it is
titlestringIts name

Examples

Minimal

dashboards/renewals.mdx
---
scope: customer/success-manager
---
<TaskInbox />

Leaseline

dashboards/renewals.mdx
---
scope: customer/success-manager
title: Renewals
---
<MetricTile metric="renewals.answeredRate" window="month" />
<DataTable noun="Lease" where="status = renewing" sort="endsOn" />
<TaskInbox role="customer/success-manager" />
<ApprovalSheet />

What it builds

The StartupBuilder compiles the file.

  • a Dashboard, rendered as HTML for people, JSON for native clients and Markdown for agents
  • the Markdown form is the first context of every agent in the scope
  • Dashboard.ask answers questions about it in words

Routing

/dashboard/customer/success-manager in the Startup's operator App.

Good to know