视图预览

POST

/ds/view/preview

预览分为时时预览和根据已保存的配置（id）预览，返回的结果一致。
当请求参数中的mode为live时，根据body中的参数进行预览。
其余情况，解析请求参数id为视图id，进行预览。
只会返回前1000行。

请求参数

Query 参数

Header 参数

Body 参数application/json

示例

{
    "catalog": {
        "id": "string"
    },
    "config": {
        "drill": [
            "string"
        ],
        "echartType": "string",
        "fields": [
            {
                "alias": "string",
                "name": "string",
                "option": {
                    "aggregator": "count",
                    "defaultValue": null,
                    "distinct": true,
                    "filter": {
                        "name": "string",
                        "op": "eq",
                        "value": null
                    }
                }
            }
        ],
        "group": [
            {
                "alias": "string",
                "name": "*",
                "option": {
                    "format": "Y-m-dTH:M:00",
                    "method": "$dateToString"
                }
            }
        ],
        "groupAlias": [
            "string"
        ],
        "limit": 1000,
        "noGroupBy": true,
        "offset": 0,
        "order": [
            {
                "desc": true,
                "name": "string"
            }
        ],
        "stack": [
            "string"
        ],
        "where": [
            [
                {
                    "name": "string",
                    "op": "eq",
                    "value": null
                }
            ]
        ]
    },
    "datasetId": "string",
    "name": "string",
    "order": 0,
    "style": {}
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ds/view/preview' \
--header 'Authorization: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "catalog": {
        "id": "string"
    },
    "config": {
        "drill": [
            "string"
        ],
        "echartType": "string",
        "fields": [
            {
                "alias": "string",
                "name": "string",
                "option": {
                    "aggregator": "count",
                    "defaultValue": null,
                    "distinct": true,
                    "filter": {
                        "name": "string",
                        "op": "eq",
                        "value": null
                    }
                }
            }
        ],
        "group": [
            {
                "alias": "string",
                "name": "*",
                "option": {
                    "format": "Y-m-dTH:M:00",
                    "method": "$dateToString"
                }
            }
        ],
        "groupAlias": [
            "string"
        ],
        "limit": 1000,
        "noGroupBy": true,
        "offset": 0,
        "order": [
            {
                "desc": true,
                "name": "string"
            }
        ],
        "stack": [
            "string"
        ],
        "where": [
            [
                {
                    "name": "string",
                    "op": "eq",
                    "value": null
                }
            ]
        ]
    },
    "datasetId": "string",
    "name": "string",
    "order": 0,
    "style": {}
}'

返回响应

🟢200预览结果

application/json

Body

示例

{
    "args": [
        null
    ],
    "data": [
        null
    ],
    "fields": [
        {
            "biType": "string",
            "biTypeFmt": "precision:ms",
            "calculated": true,
            "checked": true,
            "colIndex": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "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服务器错误

修改于 2024-05-14 02:41:56

创建视图

删除视图