Logo
    立即注册
    开放平台
    产品文档
    商品价格分布
    最近更新时间:2023-08-09 17:45:37

    1. 接口描述

    接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.item.salePrice.distribute 请求方式:POST 描述:通过该接口可查看电商商品价格分布数据详情,包括:价格区间段、商品数量,具体输出内容可查看输出参数示例。

    2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称 必选 默认值 类型 参数示例 描述
    appkey string "predeploy" 权限校验标识
    filters Array of RequestCommentFilters (见接口示例) 查询过滤条件
    openStrategy boolean false 是否接受缓存
    page integer 1 分页查询的页码,默认1
    pageSize integer 20 分页查询的单页数据条数,默认20

    3. 输出参数

    参数名称 必选 类型 参数示例 描述
    code integer 0 返回状态码,内部定义
    data Array of ResponseDataOfCommentDetailVo (见接口示例) 查询过滤条件
    msg string "接口返回成功!" 接口返回信息说明,在接口返回失败时会有
    openStrategy booleam false 是否接受缓存
    success boolean true 接口返回是否成功

    4. 数据结构

    4.1 RequestItemPriceDistributedFilters

    参数名 必选 类型 参数示例 描述
    brandId integer "68" 品牌id
    brandName string "小米" 品牌名
    categoryId integer "1123" 品类ID
    categoryName string "口红" 品类名(不限层级查询)
    siteId integer 5 站点ID,天猫:10,京东:5
    distributedNum integer 10 分布区间数量,默认:10
    queryDate array {"end":1635695999000,"start":1627747200000} 时间范围。时间最大跨度为366天
    trendName string "修护" 趋势
    trendType string "人群" 趋势类型
    leoExpression string {\"1##name\": [\"{EXP}\", \"无糖\"],\"2##type\": [\"{EXP}\", \"成分/原料/材质\"]} leo表达式,现在支持趋势类型、名称的筛选
    boolExpression string 1 AND 2 辅助leo表达式的布尔逻辑

    4.2 ResponseDataOfItemPriceDistributedVo

    参数名 必选 类型 参数示例 描述
    dataset [Array of CommentDetailVo,Array of CommentDetailVo] (见接口请求示例) 返回数据集,不同接口返回结果的格式不一样
    meta array "list" 返回数据格式:list、aggregation、graph
    page integer 1 分页查询的页码
    pageSize integer "20" 分页查询的单页数据条数
    time integer "955" 查询总耗时,单位毫秒
    total integer "34500230" 查询数据总量

    4.2.1 ItemPriceDistributedVo

    参数名 必选 类型 参数示例 描述
    distributedDesc string "100-1100元" 价格分区描述
    skuNum integer "1056" 商品数量

    5. 示例

    输入示例

    {
      "appkey": "predeploy",
      "filters": {
        "brandName": "雅诗兰黛",
        "distributedNum": 10,
        "queryDate": {
          "end": 1668506284000,
          "start": 1640966400000
        },
        "trendName": "修护"
      },
      "openStrategy": false,
      "page": 1,
      "pageSize": 20
    }

    输出示例

    {
      "success": true,
      "openStrategy": false,
      "code": 0,
      "msg": "接口返回成功!",
      "data": {
        "meta": {
          "datasetType": "list"
        },
        "dataset": [
          {
            "distributedDesc": "3-94元",
            "skuNum": 1195
          },
          {
            "distributedDesc": "94-188元",
            "skuNum": 327
          },
          {
            "distributedDesc": "188-282元",
            "skuNum": 513
          },
          {
            "distributedDesc": "282-376元",
            "skuNum": 333
          },
          {
            "distributedDesc": "376-470元",
            "skuNum": 283
          },
          {
            "distributedDesc": "470-564元",
            "skuNum": 422
          },
          {
            "distributedDesc": "564-658元",
            "skuNum": 241
          },
          {
            "distributedDesc": "658-752元",
            "skuNum": 209
          },
          {
            "distributedDesc": "752-846元",
            "skuNum": 50
          },
          {
            "distributedDesc": "846-940元",
            "skuNum": 176
          },
          {
            "distributedDesc": "940-5320元",
            "skuNum": 394
          }
        ],
        "total": 0,
        "time": 312
      }
    }

    6. 状态码

    以下仅列出了接口业务逻辑相关的状态码。

    状态码 描述

    微信扫描二维码在线咨询