视图预览 - AIRIOT API 4.0

调用此接口需要高级功能BI的授权。

预览分为时时预览和根据已保存的配置(id)预览,返回的结果一致。
当请求参数中的mode为live时,根据body中的参数进行预览。
其余情况,解析请求参数id为视图id,进行预览。
只会返回前1000行。
查询前可能会修改视图参数中的聚合项和堆叠项,最终使用的配置见返回的stats。

请求参数

Query 参数

string

视图id

可选

mode

enum<string>

可选

预览模式,实时预览为live,其余情况根据视图id进行预览

枚举值:

live

Header 参数

X-Request-Project

string

可选

项目ID, 默认default

Authorization

string

Token

可选

默认值:

Body 参数application/json

catalog

object

所属目录

可选

string

目录id

可选

config

object

视图参数

可选

drill

array[string]

可选

下钻列的originalName或id(未启用)

echartType

string

可选

fields

array[object (entity.SelectField) {3}]

必需

包含查询列（原始列originalName或id）、别名和聚合方法

group

array[object (entity.GroupField) {3}]

可选

聚合的列（原始列的originalName或id）

groupAlias

array[string]

可选

聚合列别名,不为空时长度需要与group相等

limit

integer

查询结果的最大条数

可选

>= 0

默认值:

1000

noGroupBy

boolean

可选

false: groups和stack里的维度列都会被group by

offset

integer

查询结果的偏移量

可选

>= 0

默认值:

order

array[object (entity.OrderByField) {2}]

排序

可选

stack

array[string]

可选

堆叠列的originalName或id(未启用)

where

array [array]

可选

视图所有查询条件组，第一级的条件为或关系，第二级的条件为与关系

datasetId

string

可选

数据集id，uuid

name

string

预览时不用传

可选

order

number

排序优先级

可选

style

object

视图样式

可选

示例

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200预览结果

application/json

Body

args

array

可选

开启SQLDebug时，返回执行查询时SQL的参数

data

array

可选

数据，格式为二维数组，第一层的元素代表一行的数据

fields

array[object (entity.DatasetField) {19}]

可选

列配置，与结果中每行数据对应

biType

enum<string>

可选

biType 用户选择的字段类型

string - 字符串类型

time - 时间类型

int - 整数类型

float - 浮点数类型

bool - 布尔类型

binary - 二进制类型

other - 其他类型(默认)

枚举值:

stringtimeintfloatboolbinaryother

biTypeFmt

string

BI字段类型备注

可选

示例值:

precision:ms

calculated

boolean

是否为计算字段

可选

checked

boolean

可选

是否选中(即预览时是否返回,默认为true)

colIndex

integer

可选

返回查询时的原始列序号

createdAt

string <date-time>

创建时间

可选

creator

string

创建用户

可选

string

可选

id,缺省时生成uuid

isMeasure

boolean

是否是指标

可选

name

string

列名称

可选

originalBiType

enum<string>

可选

根据OriginalType判断的字段类型(自动判断，不能修改)

string - 字符串类型

time - 时间类型

int - 整数类型

float - 浮点数类型

bool - 布尔类型

binary - 二进制类型

other - 其他类型(默认)

枚举值:

stringtimeintfloatboolbinaryother

originalName

string

列原始名称

可选

originalType

string

可选

数据库中类型名称(自动判断，不能修改)

示例值:

varchar

size

integer

可选

数据库中的列长度(SQL查询结果未返回时是9223372036854775807)

style

object

可选

前端配置,与功能无关

tableId

string

所属数据集id

可选

tableName

string

可选

所属数据集名称(仅限关联数据集)

updatedAt

string <date-time>

修改时间

可选

userColIdx

integer

列序号

可选

isDefault

boolean

可选

是否为默认的预览结果

sql

string

可选

开启SQLDebug时，返回执行查询时SQL

stat

object

可选

[仅视图预览]视图预览参数

grouped

boolean

可选

[来自请求]是否聚合

limit

integer

可选

[来自请求]最大数量

nCategories

integer

可选

返回结果中的维度轴数量

nStacks

integer

可选

返回结果中的堆叠轴数量

nValues

integer

可选

返回结果中的指标轴数量

offset

integer

可选

[来自请求]跳过数量

reqFields

integer

可选

[来自请求]查询字段数量

reqGroups

integer

可选

[来自请求]聚合字段数量

reqStacks

integer

可选

[来自请求]堆叠字段数量

stacked

boolean

[来自请求]堆叠项

可选

style

object

可选

前端配置,与功能无关

示例

{
  "args": [
    null
  ],
  "data": [
    null
  ],
  "fields": [
    {
      "biType": "string",
      "biTypeFmt": "precision:ms",
      "calculated": true,
      "checked": true,
      "colIndex": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "creator": "string",
      "id": "string",
      "isMeasure": true,
      "name": "string",
      "originalBiType": "string",
      "originalName": "string",
      "originalType": "varchar",
      "size": 0,
      "style": {},
      "tableId": "string",
      "tableName": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userColIdx": 0
    }
  ],
  "isDefault": true,
  "sql": "string",
  "stat": {
    "grouped": true,
    "limit": 0,
    "nCategories": 0,
    "nStacks": 0,
    "nValues": 0,
    "offset": 0,
    "reqFields": 0,
    "reqGroups": 0,
    "reqStacks": 0,
    "stacked": true
  },
  "style": {}
}

🟠400请求错误,请结合message和detail判断原因

🟠401token无效或过期

🟠403权限错误

🔴500服务器错误