Dashboard

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/tutorloop.com/dashboards/dashboard_1",
  "$type": "Dashboard",
  "scope": "Startup"
}

RelationshipsCopy Anchor Link

• A Dashboard is presented in one App: an App opens on Dashboards for the people signed in to it. presentedIn, inverse presents.
• A Dashboard shows many Metrics: a Dashboard reads out Metrics, each computed from Events and never typed in. shows, inverse shownOn.
• A Dashboard views one Thing: a Dashboard summarizes one scope, such as a Studio, a Startup, a Team, or a Role. views, inverse dashboards.

VerbsCopy Anchor Link

1. createCreates a Dashboard.
   POST /{namespace}/dashboardsdoDashboard.created
2. getReturns one Dashboard by id.
   GET /{namespace}/dashboards/{id}readNo Event
3. listReturns Dashboards, newest first, one page at a time.
   GET /{namespace}/dashboardsreadNo Event
4. updateChanges the given properties of a Dashboard.
   PATCH /{namespace}/dashboards/{id}doDashboard.updated
5. deleteDeletes a Dashboard; its history is kept.
   DELETE /{namespace}/dashboards/{id}doDashboard.deleted
6. askAsk answers a plain-language question with a query over the Startup’s records and shows the query beside the result.
   POST /{namespace}/dashboards/askdoDashboard.asked
7. scheduleSchedule sends a Dashboard on a cadence to a Mailbox, a Channel or an Agent’s context, rendered for each.
   POST /{namespace}/dashboards/{dashboard}/scheduledoDashboard.scheduled

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Ask my dashboard.

ExampleCopy Anchor Link

The Founder Dashboard of a tutoring marketplace shows bookings, open tutor hours, and runway. An Agent reads it as Markdown in its context, and the founder reads the same view on a phone.