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.
Run a measures-and-dimensions query against your event stream. Wraps POST /api/query — see the API reference.
Usage
upstack query \
--measures revenue,purchases \
--dimensions utm_source \
--date-start 2026-04-01 \
--date-end 2026-04-30
Required flags
| Flag | Description |
|---|
--measures <m1,m2,...> | Comma-separated measure ids. |
--date-start <YYYY-MM-DD> --date-end <YYYY-MM-DD> | Date range. |
Optional flags
| Flag | Description | Default |
|---|
--granularity <g> | none|second|minute|hour|day|week|month|quarter|year | day |
--dimensions <d1,d2,...> | Comma-separated dimension ids. Max 5. | |
--filters <json> | JSON array of {column, value} filters. Max 5. | |
--timezone <tz> | IANA timezone (e.g. America/New_York). | UTC |
Shared flags
All query commands (query, query-attribution, query-cohort) support these:
| Flag | Description | Default |
|---|
-i, --interactive | Build the query step-by-step with prompts. | |
--output <format> | json, table, or csv. | json |
--file <path> | Write output to a file instead of stdout. | |
--from-file <path> | Load query parameters from a JSON file. CLI flags override file values. | |
Examples
# Revenue by day, last 30 days, all dimensions defaulted
upstack query --measures revenue --date-start 2026-04-01 --date-end 2026-04-30
# Output as CSV
upstack query --measures revenue,purchases --dimensions utm_source \
--date-start 2026-04-01 --date-end 2026-04-30 \
--output csv --file ./april-by-source.csv
# Interactive
upstack query -i
Save a query for reuse
upstack saved create morning-report --command query --from-file ./params.json
upstack saved run morning-report
upstack saved for the full reference.
