获取自定义接口的数据

更新时间:2023-07-28 06:25:03下载pdf

本文介绍获取自定义接口的数据的 API。

接口描述

获取您在数据中心自定义创建接口的数据。在数据中心创建 API 的方法详见 API 管理

接口地址

POST: /v1.0/data-analysis/data

请求参数

参数名类型参数位置是否必填说明
api_codeStringqueryfalse在数据分析平台创建 API 时生成的 apiCode
paramsStringqueryfalse在数据分析平台创建 API 时自定义的参数,JSON 格式

返回参数

参数名类型说明
resultObject

result 说明

参数名类型说明
successBoolean请求是否成功
errorCodeString接口失败时的错误码,成功时不返回该数据
errorMsgString接口失败时的错误信息,成功时无此字段
resultDOObject返回的具体数据

resultDO 说明

参数名类型说明
dataList响应的具体数据,里面的格式就是您在数据分析平台创建 API 时定义的返回值格式
pageNoInteger当前第几页
totalCountInteger一共有多少条数据

请求示例

POST: /v1.0/data-analysis/data
{
  "apiCode": "yourApiCode",
  "params": {
    "fields": "your fields"
  }
}

返回示例

{
    "result": {
        "resultDO": {
            "data": [
            ],
            "totalCount": 1,
            "pageNo": 1
        },
        "success": true
    },
    "t": 1626250948216,
    "success": true
}

错误码

参考 错误码