参数 | 是否必须 | 说明 |
---|---|---|
pageSize | 否 | 分页返回的单页数据条数 |
currentPage | 否 | 分页返回的页码 |
sort | 否 | 返回的数据按照哪个字段来排序,字段名称(真名) |
order | 否 | 接受ASC和DESC两个值,分别排序时的表示正序和逆序 |
filters | 否 | 对数据的筛选条件,可接收的变量由接口在data.meta.parameters中定义 |
token | 按需 | 如果接口开启了安全校验,则必须传该值,由方舟处理,接口开发者无需关注 |
http请求方式: POST(请使用https协议)
https://matrix.datastory.com.cn/serv/display/3RS3/leo/a_list
通过POST提交参数
{
"pageSize":3,
"filters":{
"购买时间":[],
"内容分词":["新鲜","划算"]
},
"openStrategy":false
}
或在命令行中执行如下命令
curl 'https://matrix.datastory.com.cn/serv/v2/display/3RS3/books/doc/list' \
-H 'Content-Type: application/json' \
--data-binary '{"pageSize":3,"filters":{"购买时间":[],"内容分词":["新鲜","划算"]},"openStrategy":false}'
正确时返回的 Response Headers
X-Matrix-IsCache: true #当前返回的data是否是缓存
X-Matrix-TookTime: 0.036 #从接收到请求到返回结果用时,方舟统计
X-Matrix-Type: display #接口是使用什么方式发布的
X-Matrix-Version: 2 #接口版本,当前规范就是2
X-Matrix-Url: v2/display/3RS3/books/doc/list #接口在方舟上发布的地址
X-Matrix-Name: list案例 #接口在方舟上的名称
正确时返回的 Response
{
"code" : 0,
"data" : {
"meta" : {
"version" : "2",
"datasourceId" : 6291,
"datasetType" : "list",
"measures" : [ ],
"parameters" : [ {
"schemeField" : "6291_buy_time",
"apiParam" : "购买时间"
}, {
"schemeField" : "6291_content_seg",
"apiParam" : "内容分词"
} ],
"fieldsInfo" : [ {
"fieldName" : "6291_keywords",
"fieldAlias" : "关键词",
"fieldIsNested" : 0,
"fieldIsArray" : 1,
"fieldIsAnalyzed" : 0,
"fieldType" : "string",
"dateFormat" : null
}, {
"fieldName" : "6291_author",
"fieldAlias" : "作者",
"fieldIsNested" : 0,
"fieldIsArray" : 0,
"fieldIsAnalyzed" : 0,
"fieldType" : "string",
"dateFormat" : null
}, {
"fieldName" : "6291_site_name",
"fieldAlias" : "站点名称",
"fieldIsNested" : 0,
"fieldIsArray" : 0,
"fieldIsAnalyzed" : 0,
"fieldType" : "string",
"dateFormat" : null
}, {
"fieldName" : "6291_content_seg",
"fieldAlias" : "内容分词",
"fieldIsNested" : 0,
"fieldIsArray" : 1,
"fieldIsAnalyzed" : 0,
"fieldType" : "string",
"dateFormat" : null
}, {
"fieldName" : "6291_buy_time",
"fieldAlias" : "购买时间",
"fieldIsNested" : 0,
"fieldIsArray" : 0,
"fieldIsAnalyzed" : 0,
"fieldType" : "date",
"dateFormat" : "yyyy-MM-dd HH:mm:ss"
} ],
"dimensions" : {
"headers" : [ "6291_site_name", "6291_author", "6291_keywords", "6291_buy_time" ]
}
},
"dataset" : {
"total" : 5412,
"pageSize" : 3,
"currentPage" : 1,
"list" : [ {
"站点名称" : "京东",
"作者" : "啊琳琳喜欢胡宇威",
"关键词" : [ "口味", "日期", "活动", "特价", "超市" ],
"购买时间" : "2019-06-13 15:39:09"
}, {
"站点名称" : "天猫",
"作者" : "吴**0",
"关键词" : [ "冰袋", "卖家", "备注", "隔天", "顺丰" ],
"购买时间" : ""
}, {
"站点名称" : "天猫",
"作者" : "吉**9",
"关键词" : [ "划算", "新鲜", "日期", "活动", "超市" ],
"购买时间" : ""
} ]
}
},
"success" : true,
"message" : "success"
}
关键参数说明(有*标记的是与aggregation规则不一致的参数)
参数 | 说明 | 备注 | |
---|---|---|---|
data.meta.version | 当前接口规范的版本 | 2 | |
data.meta.datasetType | 当前接口返回的数据格式 | aggregation、list、graph | |
data.meta.datasourceId | 当前数据接口查询的数据源ID | 如果同时查了多个数据表,或没有查数据表,可为空 | |
* | data.meta.dimensions | 数据集的维度 | 每一个字段是一个维度 |
* | data.meta.dimensions.headers | list数据集的表头 | 按顺序排列的表头字段 |
data.meta.parameters | 数据集的过滤参数 | 表示数据集可以接受的变量,数组结构表示多个变量 | |
data.meta.parameters.[].apiParam | 数据集的过滤参数名 | 有中文别名时一般取中文名,也作为过滤参数名 | |
data.meta.parameters.[].schemeField | 过滤参数对应的底层数据表字段名 | 参数对应的数据库字段名 | |
* | data.meta.measures | 无需该参数 | 为空即可 |
data.meta.fieldsInfo | 字段类型的说明 | 仅包含dimensions、parameters、measures中出现的字段 | |
data.meta.fieldsInfo.[].fieldName | 在数据库底层表中的字段名 | 有别名时取别名,无别名时取字段名 | |
data.meta.fieldsInfo.[].fieldAlias | 字段别名信息,方舟的接口参数优先使用别名 | 0、1 | |
data.meta.fieldsInfo.[].fieldIsNested | 字段是否是嵌套类型字段(如三元组) | 0、1 | |
data.meta.fieldsInfo.[].fieldIsArray | 字段是否是数组类型字段(如关键词分词) | 0、1 | |
data.meta.fieldsInfo.[].fieldIsAnalyzed | 字段是否是长文本字段(支持模糊搜索) | 0、1 | |
data.meta.fieldsInfo.[].fieldType | 字段类型 | string、date 、integer | |
* | data.meta.fieldsInfo.[].dateFormat | 字段的时间格式,用于给前端转化为时间戳的时候参考 | yyyy-MM-dd HH:mm:ss、null |
* | data.dataset.total | 数据总记录数 | |
* | data.dataset.pageSize | 当前页的数据计数数 | |
* | data.dataset.currentPage | 当前页码 | |
* | data.dataset.list | 数据集的数据部分 |
产品咨询
020-38061725
微信扫描二维码在线咨询