Dashboard routes: ask, schedule

Reference for Dashboard, one group of Dashboard routes.

Dashboard.ask

Ask answers a plain-language question with a query over the Startup’s records and shows the query beside the result. Verb page.

Text

POST /{namespace}/dashboards/ask

Body, as JSON: the inputs. Emits Dashboard.asked.

Inputs

Input	Type	Required	Description
`question`	`text`	required	The question, in plain language.
`dashboard`	Dashboard		The Dashboard to add the answer to as a tile.

Returns

Output	Type	Required	Description
`query`	`text`	required	The query it ran, to read and reuse.
`rows`	`json`	required	The result, as a table or chart.
`dashboard`	Dashboard	required	The Dashboard the question was asked on.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/dashboards/ask \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"Example question"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "query": "Example query",
  "rows": {},
  "dashboard": {
    "$id": "https://api.sb/leaseline.app/dashboards/dashboard_QL9I0ALqO4",
    "$type": "Dashboard",
    "scope": "Startup"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Dashboard.ask",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Dashboard.schedule

Schedule sends a Dashboard on a cadence to a Mailbox, a Channel or an Agent’s context, rendered for each. Verb page.