Skip to content

Configuration format

The config file ties a source to a widget and defines how refreshes happen.

sources:
- id: stripe_main
type: stripe
refreshInterval: 300
widgets:
- id: mrr
source: stripe_main
query: mrr
FieldMeaning
idUnique source identifier used by widgets and refreshes
typeConnector type, such as stripe, postgres, or github
refreshIntervalOptional refresh interval in seconds
queryNamed query or endpoint the connector should execute

dashboard.json stores the values rendered by the UI. A widget update can set multiple properties at once:

{
"id": "mrr",
"value": 4800,
"trend": "+14%"
}

The local widget endpoint lets an agent patch one widget at a time instead of touching the whole dashboard file. That keeps updates narrow and makes the resulting state easy to review.