Get Dataset Data

POST

/public-api/data-source/{dsId}/data

API Description

This API returns up to 50,000 rows per request. If dataset is large, please specify filter conditions.
Note: BI versions 5.10.0 and above support this interface

Request

Path Params

Header Params

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "result": "ok",
    "response": {
        "dsId": "v2a769c4be17d4ec8b77b2b2",
        "name": "Comparison Subscription Test",
        "displayType": "EXCEL",
        "storageId": "v2a769c4be17d4ec8b77b2b2",
        "domId": "testing",
        "uId": "h2afb13f76d4843e298e4f4f",
        "parentDirId": "efae4f1696f024d599bba4f0",
        "rowCount": 6,
        "colCount": 4,
        "status": "FINISHED",
        "columns": [
            {
                "name": "Province",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "teebf36bc63d94e7ebe6b4bc",
                "metaType": "DIM",
                "seqNo": 0,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "Gender",
                "fdType": "STRING",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "o0ed08788ea9949909986db2",
                "metaType": "DIM",
                "seqNo": 1,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "Order Count",
                "fdType": "LONG",
                "dsId": "v2a769c4be17d4ec8b77b2b2",
                "fdId": "j9a566f3ee11144f9a5f9f8e",
                "metaType": "METRIC",
                "seqNo": 2,
                "isAggregated": false,
                "calculationType": "normal",
                "level": "dataset",
                "annotation": "",
                "isDetectionSensitive": false,
                "isSensitive": false,
                "isRestricted": false
            },
            {
                "name": "Average Order Value",
                "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": [
            [
                "Zhejiang",
                "Male",
                "1",
                "3"
            ],
            [
                "Zhejiang",
                "Female",
                "2",
                "4"
            ],
            [
                "Shanghai",
                "Male",
                "5",
                "7"
            ],
            [
                "Shanghai",
                "Female",
                "6",
                "8"
            ],
            [
                "Jiangsu",
                "Male",
                "2",
                "3"
            ],
            [
                "Jiangsu",
                "Female",
                "5",
                "3"
            ]
        ]
    }
}

Modified at 2026-07-15 06:37:29

Download Dataset Data

Create Dataset