Skip to content

by Startups.Studio

Product Sites and apps Dashboard

Dashboard.ask

POST /{namespace}/dashboards/ask

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

Noun: Dashboard
Mode: do
Event: Dashboard.asked

You, to your agent

Ask my dashboard.

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

import { $ } from 'startup-builder'

const { query, rows, dashboard } = await $.Dashboard.ask({ question: 'Example question' })

npx startup-builder do Dashboard.ask --json '{"question":"Example question"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Dashboard.ask({ question: 'Example question' })"
  }
}

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.

Outputs

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.

Effects

Emits Dashboard.asked.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
Reads only records the asker’s Permissions allow.

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.	Dashboard.ask

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Dashboard

Previous Page

Dashboard.create

Next Page