aggregation类型

本页内容

接口调用说明 #

参数 是否必须 说明
openStrategy 否 是否接受方舟的缓存策略，当为false的时候，表示不接受缓存
filters 否 对数据的筛选条件，可接收的变量由接口在data.meta.parameters中定义
token 按需 如果接口开启了安全校验，则必须传该值，由方舟处理，接口开发者无需关注

动动手 #

http请求方式: POST（请使用https协议）
https://matrix.datastory.com.cn/serv/v2/api/3RS3/books/doc/agg

通过POST提交筛选条件

{
  "openStrategy":true,
  "filters":{
    "购买时间":["{EXP}","[1556640000000,1559318399999]"],
    "内容分词":["好喝","便宜"]
  },
}

或在命令行中执行如下命令

curl 'https://matrix.datastory.com.cn/serv/v2/api/3RS3/books/doc/agg' \
  -H 'Content-Type: application/json' \
  --data-binary '{"filters":{"购买时间":["{EXP}","[1556640000000,1559318399999]"],"内容分词":["好喝","便宜"]},"openStrategy":true}'

返回说明 #

正确时返回的 Response Headers

X-Matrix-IsCache: false #当前返回的data是否是缓存
X-Matrix-TookTime: 0.007 #从接收到请求到返回结果用时，方舟统计
X-Matrix-Type: pivot #接口是使用什么方式发布的
X-Matrix-Version: 2 #接口版本，当前规范就是1.1
X-Matrix-Url: v2/api/3RS3/books/doc/agg #接口在方舟上发布的地址
X-Matrix-Name: agg案例 #接口在方舟上的名称

正确时返回的 Response

{
  "code": 0,
  "data": {
    "meta": {
      "version": "2",
      "datasourceId": 6291,
      "datasetType": "aggregation",
      "measures": [
        "6291_profilers_name"
      ],
      "parameters": [
        {
          "schemeField": "6291_buy_time",
          "apiParam": "购买时间"
        },
        {
          "schemeField": "6291_content_seg",
          "apiParam": "内容分词"
        }
      ],
      "fieldsInfo": [
        {
          "fieldName": "6291_profilers_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": null
        }
      ],
      "dimensions": {
        "rowIndices": [
          "6291_profilers_name"
        ],
        "colIndices": []
      }
    },
    "dataset": {
      "data": [
        [ "分析对象", "分析对象(记录数)" ],
        [ "蒙牛冠益乳", 468 ],
        [ "明治", 248 ],
        [ "活润", 185 ],
        [ "卡士餐后一小时", 119 ],
        [ "光明健能", 71 ],
        [ "伊利畅轻", 52 ],
        [ "简爱身体知道", 36 ],
        [ "君乐宝纯享", 23 ],
        [ "达能碧悠", 11 ]
      ],
      "headerCols": 1,
      "headerRows": 1
    }
  },
  "success": true,
  "message": "success",
  "openStrategy": false
}

关键参数说明

参数 说明 备注
data.meta.version 当前接口规范的版本 2
data.meta.datasetType 当前接口返回的数据格式 aggregation 、list、graph
data.meta.datasourceId 当前数据接口查询的数据源ID 如果同时查了多个数据表，或没有查数据表，可为空
data.meta.dimensions 数据集的维度 在aggregation类型中分为行维度和列维度
data.meta.dimensions.rowIndices 透视表的行维度 数据集按行展开的维度，在上面案例中，每一行都是一个“分析对象”(6291_profilers_name)
data.meta.dimensions.colIndices 透视表的列维度 数据集按列展开的维度
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、yyyy-MM、yyyy-MM-dd、yyyy-MM-dd HH、null
data.dataset.data 数据集的数据部分，二维数组，每一个子数组都是表格的一行
data.dataset.headerCols 列索引数量
data.dataset.headerRows 行索引数量