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.

List the catalog of filter fields available across every query endpoint. Each entry declares its operators, value type, and the contexts it applies in. Useful for finding canonical filter field ids before constructing a query, attribution query, cohort analysis, or channel-details listing. Wraps GET /api/filters — see the API reference.

​
Usage

upstack filters
The endpoint takes no parameters — the full catalog is returned in one call. Results are cached locally for 1 hour; pass --no-cache to refetch.

​
Flags

FlagDescription
--search <term>Filter results by keyword (matches field and label).
--detailInclude label, description, value type, supported operators, and applicable contexts.
--operatorsShow supported operators inline next to each field.
--jsonPrint the raw response as JSON (one object per field).
--no-cacheBypass the local 1-hour cache and refetch.

​
Examples

upstack filters
upstack filters --search utm
upstack filters --detail
upstack filters --operators
upstack filters --json | jq '.[] | select(.applicableContexts | index("attribution"))'

​
Narrowing by endpoint context

Every entry carries an applicableContexts array listing which endpoints it applies to (query_measures, cohort_analysis, products_report, attribution, channel_details, emq_analytics). Use --detail to see them inline, or --json to narrow with jq: 
# Fields valid on POST /api/query-channel-details
upstack filters --json | jq '.[] | select(.applicableContexts | index("channel_details"))'