Configuration defaults

Set per-profile defaults so you don’t repeat common flags. A CLI flag beats a value from --from-file, which beats a default: defaults < file values < CLI flags. Where you set nothing at all, timezone falls back to UTC and output to json.

Usage

upstack config set <key> <value>
upstack config get [key]
upstack config unset <key>

Supported keys

Key	Description	Example
`timezone`	IANA timezone applied to query date ranges.	`America/New_York`
`output`	Default output format.	`json`, `table`, or `csv`
`granularity`	Default granularity for query / cohort commands.	`day`
`currency`	ISO 4217 code money values are converted to. Without it the server converts to `USD` — set this if your store sells in another currency. See Reporting currency.	`GBP`

Examples

upstack config set timezone America/New_York
upstack config set output table
upstack config set currency GBP

upstack config get               # print all defaults for the active profile
upstack config get granularity   # print one key

upstack config unset granularity

Defaults are stored under the active profile in ~/.upstackrc:

{
  "profiles": {
    "default": {
      "apiKey": "upstack_...",
      "pixelId": "...",
      "defaults": { "timezone": "America/New_York", "output": "table" }
    }
  }
}

How each default applies per command:

Key	`query`, `query-cohort`, `query-channel-details`	`query-attribution`	`saved run`
`granularity`	Applied	— (no granularity flag)	—
`timezone`	Applied	Applied	— (use `run` override flags)
`currency`	Applied	Applied	— (use `run` override flags)
`output`	Applied	Applied	Applied

GETTING STARTED

ACCOUNT

DISCOVERY

QUERIES

DASHBOARDS

COSTS

PRODUCTS

ADVANCED

Usage

Supported keys

Examples

​Usage

​Supported keys

​Examples

Usage

Supported keys

Examples