Skip to main content
GET
Get one saved query

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

key
string
required

The integration key, such as snowflake or salesforce

query_id
string
required

Response

200 - application/json

Successful Response

A saved query as stored. Its resolver, mapping and transformer objects have the same shapes a create or a change takes.

account_resolver
Account Resolver · object | null
required
custom_field_mappings
Custom Field Mappings · object[] | null
required
custom_object_config
Custom Object Config · object | null
required
entity_type
enum<string>
required
Available options:
account,
people
group_by_columns
string[] | null
required
id
string | null
required

Stable id. Null only on a query saved before ids existed: any save of the config gives it one

is_active
boolean
required
limit
integer | null
required
name
string
required
order_by_columns
string[] | null
required
period
enum<string> | null
required
Available options:
HOURLY,
TWO_HOURS,
FOUR_HOURS,
SIX_HOURS,
TWELVE_HOURS,
DAILY,
WEEKLY,
MONTHLY
person_resolver
Person Resolver · object | null
required
product_usage_mappings
Product Usage Mappings · object[] | null
required
query_type
enum<string>
required
Available options:
custom_field,
product_usage,
custom_object
sql
string
required
transformers
Transformers · object[] | null
required
version
integer
required

The config's version: send it as expected_version with a change