获取数据集数据 - 观远数据开放平台

请求参数

Path 参数

dsId

string

必需

Header 参数

X-Auth-Token

string

个人Token

必需

示例值:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxLVBBTS9VZkQwNkpQUFVCTkxacXJFcWprSHR5SXpUaCtRZmI2OHNSbFM5UnJuUFpiSmR3bFVnbHRVTnhjUmhJTVhJRnJyR0VvMzRVd3drek9RdHQ0MlhvNUhjUFJPTjVXbVUrRzZtK1ZTNTVDVjI2LzZ6NTlmMEV0UDM1ZEVLZWNSRVJBQ1hTUT0iLCJhdXRvTG9nb3V0T25DbG9zZUVuYWJsZWQiOmZhbHNlLCJpc3MiOiJndWFuZGF0YS5jb20iLCJleHAiOjE3MzM5MDUxNjEsImlhdCI6MTczMjY5NTU2MSwiaW5pdFRpbWUiOiIyMDI0LTExLTI3IDE2OjE5OjIxLjA1NSIsImp0aSI6IjExMzU3MWE4ZTE4ODI3ZTQyYmRlM2EyYWU5M2RlODc0YWFiZjAwNjM0ODNkY2E4ZDhmNGYxZjNiMTJkNjUwZTc1NDUwMTMyMWIxNzA2MjYwYjA1ZGIzZTdhZWRmZTdhMjFlNDQxNzJhYWQxZDE0OTBmZmZjZDI5NDVlODNjYjUxOWYwMmFjNjZjMmJiODQyN2IwMjY5ZmE3MmY3MWJlOGJlZDUyZGFiZWMxYzQwZjQxZmUyYmE2Nzc3NTY1NjU3YjQ5YzUxMmRkZGUwYTllYWU4ZWMzZjUzMzhhZDMzNGM2NWJjYzcwYTAwMzhiM2M2ZDUyMzkxZjM0NzVhNWVjYzciLCJwd2RWZXJzaW9uIjowLjB9.7XLS3rEZWuP7aDTBVwgmzyouVf_APlWU88ZsFGvrCJI

Body 参数application/json

offset

integer

从第几条开始

可选

limit

integer

一页显示多少条

可选

filter

object

过滤条件

可选

combineType

enum<string>

多个条件结合方式

必需

枚举值:

ANDOR

conditions

array [object {2}]

条件列表

必需

sortFactor

object

排序设置

可选

name

string

排序字段名

必需

sortType

enum<string>

排序方式

必需

枚举值:

descasc

示例

{
    "offset": 1,
    "limit": 3,
    "sortFactor": {
        "name": "id",
        "sortType": "desc"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/public-api/data-source//data' \
--header 'X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxLVBBTS9VZkQwNkpQUFVCTkxacXJFcWprSHR5SXpUaCtRZmI2OHNSbFM5UnJuUFpiSmR3bFVnbHRVTnhjUmhJTVhJRnJyR0VvMzRVd3drek9RdHQ0MlhvNUhjUFJPTjVXbVUrRzZtK1ZTNTVDVjI2LzZ6NTlmMEV0UDM1ZEVLZWNSRVJBQ1hTUT0iLCJhdXRvTG9nb3V0T25DbG9zZUVuYWJsZWQiOmZhbHNlLCJpc3MiOiJndWFuZGF0YS5jb20iLCJleHAiOjE3MzM5MDUxNjEsImlhdCI6MTczMjY5NTU2MSwiaW5pdFRpbWUiOiIyMDI0LTExLTI3IDE2OjE5OjIxLjA1NSIsImp0aSI6IjExMzU3MWE4ZTE4ODI3ZTQyYmRlM2EyYWU5M2RlODc0YWFiZjAwNjM0ODNkY2E4ZDhmNGYxZjNiMTJkNjUwZTc1NDUwMTMyMWIxNzA2MjYwYjA1ZGIzZTdhZWRmZTdhMjFlNDQxNzJhYWQxZDE0OTBmZmZjZDI5NDVlODNjYjUxOWYwMmFjNjZjMmJiODQyN2IwMjY5ZmE3MmY3MWJlOGJlZDUyZGFiZWMxYzQwZjQxZmUyYmE2Nzc3NTY1NjU3YjQ5YzUxMmRkZGUwYTllYWU4ZWMzZjUzMzhhZDMzNGM2NWJjYzcwYTAwMzhiM2M2ZDUyMzkxZjM0NzVhNWVjYzciLCJwd2RWZXJzaW9uIjowLjB9.7XLS3rEZWuP7aDTBVwgmzyouVf_APlWU88ZsFGvrCJI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "offset": 1,
    "limit": 3,
    "sortFactor": {
        "name": "id",
        "sortType": "desc"
    }
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

object

响应结果

必需

dsId

string

数据集ID

必需

name

string

数据集名

必需

displayType

string

数据集类型

必需

storageId

string

可选

domId

string

域ID

必需

uId

string

用户ID

必需

parentDirId

string

父目录ID

必需

rowCount

integer

行数

必需

colCount

integer

列数

必需

status

string

状态

可选

columns

array [object {13}]

字段列表

必需

ctime

string

创建时间

必需

utime

string

更新时间

必需

version

integer

版本

必需

cardCount

integer

卡片数量

可选

preview

array [array]

预览

必需

示例

{
    "result": "ok",
    "response": {
        "dsId": "v2a769c4be17d4ec8b77b2b2",
        "name": "对比订阅测试",
        "displayType": "EXCEL",
        "storageId": "v2a769c4be17d4ec8b77b2b2",
        "domId": "testing",
        "uId": "h2afb13f76d4843e298e4f4f",
        "parentDirId": "efae4f1696f024d599bba4f0",
        "rowCount": 6,
        "colCount": 4,
        "status": "FINISHED",
        "columns": [
            {
                "name": "省",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "teebf36bc63d94e7ebe6b4bc",
                "metaType": "DIM",
                "seqNo": 0,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "性别",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "o0ed08788ea9949909986db2",
                "metaType": "DIM",
                "seqNo": 1,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "订单数",
                "fdType": "LONG",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "j9a566f3ee11144f9a5f9f8e",
                "metaType": "METRIC",
                "seqNo": 2,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "客单价",
                "fdType": "LONG",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "eedec668e19c34b578687e34",
                "metaType": "METRIC",
                "seqNo": 3,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            }
        ],
        "ctime": "2024-10-09 18:53:36+0800",
        "utime": "2024-10-11 09:47:50+0800",
        "version": 2,
        "cardCount": 1,
        "preview": [
            [
                "浙江",
                "男",
                "1",
                "3"
            ],
            [
                "浙江",
                "女",
                "2",
                "4"
            ],
            [
                "上海",
                "男",
                "5",
                "7"
            ],
            [
                "上海",
                "女",
                "6",
                "8"
            ],
            [
                "江苏",
                "男",
                "2",
                "3"
            ],
            [
                "江苏",
                "女",
                "5",
                "3"
            ]
        ]
    }
}