运行内嵌查询

版本 4.0.23.6(最新)

运行在发布的正文中以内嵌方式指定的查询。

这样一来,所发布的查询便可以按照 JSON 中定义的查询运行。将发布和运行查询的这两项操作合并为一个步骤。

以下是 JSON 格式的示例正文:

{
  "model":"thelook",
  "view":"inventory_items",
  "fields":["category.name","inventory_items.days_in_inventory_tier","products.count"],
  "filters":{"category.name":"socks"},
  "sorts":["products.count desc 0"],
  "limit":"500",
  "query_timezone":"America/Los_Angeles"
}

使用 Ruby SDK 时,系统会将其作为 Ruby 哈希进行传递,如下所示:

{
 :model=>"thelook",
 :view=>"inventory_items",
 :fields=>
  ["category.name",
   "inventory_items.days_in_inventory_tier",
   "products.count"],
 :filters=>{:"category.name"=>"socks"},
 :sorts=>["products.count desc 0"],
 :limit=>"500",
 :query_timezone=>"America/Los_Angeles",
}

这将以“result_format”参数指定的格式返回查询结果。

支持的格式:

result_format 说明
json 纯 json
json_detail 行数据以及描述查询的字段、数据透视表、表计算和其他方面的元数据
csv 以英文逗号分隔的值,带有标题
txt 使用标头制表符分隔值
html 简单 HTML
MD 简单 Markdown
XX MS Excel 电子表格
sql 返回生成的 SQL,而不是运行查询
png 查询可视化图表的 PNG 图片
jpg 查询可视化的 JPG 图片

请求

POST /queries/run/{result_format}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
result_format
字符串
结果格式
body
HTTP 正文
展开 HTTPBody 定义...
body
内嵌查询
展开查询定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
模型
字符串
模型
视图
字符串
探索名称
字段
字符串 []
数据透视
字符串 []
fill_fields
字符串 []
filters
对象
过滤器
过滤条件表达式
字符串
过滤条件表达式
排序
字符串 []
限制
字符串
限制
列限制
字符串
列数上限
总计
布尔值
总计
总行数
字符串
原始总计
小计
字符串 []
vis_config
对象
可视化配置属性。这些属性通常不透明,因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键,供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。
过滤条件配置
对象
filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时,此参数的优先级高于“过滤器”。创建查询或修改现有查询时,应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。
visible_ui_sections
字符串
可见界面部分
处理后标题
字符串
Slug
动态字段
字符串
动态字段
client_id
字符串
客户端 ID:用于生成缩短的探索网址。如果由客户端设置,则必须是唯一的 22 位字母数字字符串。否则,系统会生成一个。
分享网址
字符串
分享网址
展开网址共享网址
字符串
展开后的共享网址
网址
字符串
展开后的网址
query_timezone
字符串
查询时区
has_table_calculations
布尔值
包含表计算
查询
HTTPQuery
展开 HTTPQuery 定义...
限制
整数
行数上限(可能会覆盖已保存查询中的上限)。
apply_formatting
布尔值
为每个模型应用模型指定的格式。
apply_vis
布尔值
将可视化选项应用于结果。
缓存
布尔值
从缓存中获取结果(如果有)。
图片宽度
整数
图片格式的呈现宽度。
图片高度
整数
图片格式的呈现高度。
generate_drill_links
布尔值
生成深入链接(仅适用于“json_detail”格式)。
force_production
布尔值
强制使用生产模型,即使用户处于开发模式。请注意,此标记为 false 并不保证将使用开发模型。
仅缓存
布尔值
从缓存中检索任何结果,即使结果已过期。
路径前缀
字符串
用于细目链接(网址编码)的前缀。
重新构建_pdts
布尔值
重新构建查询中使用的 PDTS。
server_table_calcs
布尔值
对查询结果执行表计算

响应

200:查询结果

数据类型
说明
(字符串)
字符串

400:错误请求

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

422:验证错误

数据类型
说明
(对象)
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429:请求数过多

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

示例