Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Manage Upstack dashboard views from the command line. Wraps the /api/dashboard/views/* endpoints — see the API reference and the per-endpoint pages under the Dashboards group for full request/response shapes.

​
Subcommands

SubcommandWraps
listGET /api/dashboard/views
show <id>GET /api/dashboard/views/{id}
buildPOST /api/dashboard/views/from-preset
create --from-filePOST /api/dashboard/views
update <id>PATCH /api/dashboard/views/{id}
copy <id>POST /api/dashboard/views/{id}/copy
delete <id>DELETE /api/dashboard/views/{id}

​
list

List dashboard views for the configured pixel. 
upstack dashboard view list
upstack dashboard view list --type view              # default
upstack dashboard view list --type attribution_view

​
show

Fetch a single view with its full configuration as JSON. 
upstack dashboard view show 5f1e6a4f-...

​
build

The high-level builder — pass a list of measures, get a finished dashboard with auto-laid-out sparkline tiles. The most common command for AI agents and quick “give me a dashboard with these KPIs” workflows. 
upstack dashboard view build \
  --name "NC + Meta Pulse" \
  --measures core.new_customer_roas,core.new_customer_mer,meta.cpm
Optional flags:
FlagDescriptionDefault
--chart-types <c1,c2,...>One chart type per measure (positional pairing).sparkline for all
--type <t>view, attribution_view, or pnl_view.view
--layout <l>Auto-layout strategy. Only kpi-grid today.kpi-grid
--attribution-model <m>first_click, last_click, or any_click.first_click
--attribution-window <days>Attribution lookback.30
--granularity <g>day|hour|week|month|...day
--date-start <YYYY-MM-DD> --date-end <YYYY-MM-DD>Date range.last 30 days
--from-file <path>JSON file with any of the above. CLI flags override.
The CLI resolves each measure’s friendly shortTitle from GET /api/measures (cached) before posting, so widget titles read nicely in the web app.

​
create

Advanced — create a view from a full DashboardViewConfiguration body. Use build instead unless you have a specific configuration to load (e.g. exported from another pixel). 
upstack dashboard view create --from-file ./my-view.json
The file must contain { type, name, configuration, order? }.

​
update

Partial update — only fields you pass are changed. 
upstack dashboard view update 5f1e6a4f-... --name "Renamed"
upstack dashboard view update 5f1e6a4f-... --order 3
upstack dashboard view update 5f1e6a4f-... --from-file ./partial.json

​
copy

Duplicate a view. 
upstack dashboard view copy 5f1e6a4f-...

​
delete

Delete a view. Prompts for confirmation; --yes skips the prompt. 
upstack dashboard view delete 5f1e6a4f-... --yes