Logo
    立即注册
    开放平台
    产品文档
    品牌销售数据汇总
    最近更新时间:2023-05-06 12:14:45

    1. 接口描述

    接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.item.brand-metric 请求方式:POST 描述:通过该接口可查看电商商品品牌维度数据详情,包括:品类、自然月销额、自然月销量、自然月售价、站点名、站点ID、商品唯一ID、日期等等,具体输出内容可查看输出参数示例。

    2. 输入参数

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

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

    3. 输出参数

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

    4. 数据结构

    4.1 RequestltemFilters

    参数名 必选 类型 参数示例 描述
    brandId integer 68 品牌名ID
    brandName string "小米" 品牌名
    categoryId integer "68" 品类id
    categoryIds list [5643,6515,6519,6521] 品类ID
    categoryName string "奶粉" 标准品类名(与品类id二选一,优先查品类id) 注:仅支持末级品类,该参数准备废弃,建议使用spCategoryName
    spCategoryId string "68" 标准品类id(查询该品类下所有的子品类)
    spCategoryName string "3c数码" 标准品类名(查询该品类下所有的子品类)
    spCategoryNames array [ "3C数码", "美妆个护" ] 品类数组,用于支持筛选行业(仅支持品牌汇总接口)
    specifyBrandCategoryRelation boolean false 是否指定品牌品类关系
    crawlerDate array {"end":1635695999000,"start":1627747200000} 商品爬取时间。注:默认最近一年的时间,允许缺失时间值,如2021-6月~2022-5月
    filterSkuIds array "list" 根据商品过滤聚合时传
    limitBcWhitelist boolean true 是否限制品牌品类白名单
    siteId integer 5 站点ID,天猫:10,京东:5
    siteIds integer [5,10] 站点数组
    shopName string "修丽可官方旗舰店" 店铺名称
    skuId long "637338326057" 商品SkuId
    title string "苹果8plus" 商品标题,不传则查询时不限制商品标题
    trendName string "修护" 趋势名数组
    trendType string "人群" 趋势类型
    requestPrice object { "start": 100.1, "end": 10000.1 } 商品价格范围(json格式)
    optionalFields array ["itemCnt"] 可选的的字段,支持[itemCnt(商品数),brandCnt(品牌数),commodityCnt(产品数)]
    shopTypes int 2 店铺类型,0:其他、1:专卖店、2:旗舰店
    brandFuzzySearch boolean false 品牌名是否模糊匹配,true:模糊搜索 false:全值匹配
    commodityCategoryNames array ["护肤"] 产品关联的品类名(仅在根据产品汇总时才生效)

    4.2 RequestBaseMetrics

    参数名 必选 类型 参数示例 描述
    categoryLevel integer 5 品类聚合的层级粒度,范围1—5,5代表最末级,默认5
    dimensions array [ "categoryName", "brandName" ] agg查询维度字段,用于查询数据分布、趋势(例如基于品牌),仅支持开放的字段:categoryName(品类)、brandName(品牌)、commodityName(产品)、siteName(站点)、skuId(商品)、date(发表时间、采集时间)、shopName(店铺),非法参数会报错
    interval string "month" 发表时间agg查询时间单位,默认:month(目前仅支持month),非法参数会报错
    order string "desc" 排序方式:asc(升序)、desc(降序),非法参数会报错
    sort string "monthSaleCnt" 排序字段:monthSaleCnt(自然月销量)、monthSaleAmount(自然月销售额),非法参数会报错

    4.3 ResponseDataOfItemMetric

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

    4.3.1 ItemMetric

    参数名 必选 类型 参数示例 描述
    brandCnt integer "0.02482" 品牌数
    brandId integer 68 品牌id
    brandName string "苹果" 品牌名称
    categoryName string "洗发水" 末级品类名称
    firstCategoryName string "洗发水" 一级品类名称
    fourthCategoryName string "洗发水" 四级品类名称
    itemCnt integer "502" 电商商品数
    itemCntRateLP number "0.02482" 电商商品数环比
    maxSalePrice number "899.66" 自然月售价最大值
    metricDate string "2022-01" 汇总时间,格式化为月
    monthSaleAmount number "89900.85" 自然月销售额
    monthSaleCnt integer "899" 自然月销量
    monthSaleCntRateLp number "0.02482" 自然月销量环比
    monthSalePrice number "899.66" 自然月售价
    secondCategoryName string "洗发水" 二级品类名称
    siteId integer "10" 站点id
    siteName string "天猫" 站点名称
    skuId long "526498885740" 商品SkuId
    itemId String "637338326057" 商品itemId
    title String "iPad保护套2020第8代10.2寸2019苹果air3平板mini5软壳" 商品标题
    thirdCategoryName string "洗发水" 三级品类名称
    commodityId integer 32 标品id
    commodityName string "MIUI/小米 Redmi 10X 4G" 标品名称
    commodityCategoryName string "手机" 产品关联的品类名
    commodityBrandName string "小米" 产品关联的品牌名

    5. 示例

    示例1 查看品牌下的销售数据详情

    查看某个品牌某个时间段内的销售数据(时序)。

    输入示例

    {
        "appkey": "predeploy",
        "filters": {
            "brandName": "雅诗兰黛",
            "crawlerDate": {
                "end": 1649952000000,
                "start": 1640966400000
            }
        },
        "metrics": {
            "categoryLevel": 4,
            "dimensions": [
                "categoryName",
                "date"
            ],
            "interval": "month",
            "order": "desc",
            "sort": "monthSaleCnt"
        },
        "openStrategy": false,
        "page": 1,
        "pageSize": 5
    }

    输出示例

    {
      "success": true,
      "openStrategy": false,
      "code": 0,
      "msg": "接口返回成功!",
      "data": {
        "meta": {
          "datasetType": "aggregation"
        },
        "dataset": [
          {
            "fourthCategoryName": "眼霜",
            "metricDate": "2022-03",
            "monthSalePrice": 526.989,
            "monthSaleCnt": 157358,
            "monthSaleAmount": 100070061.6121,
            "perPieceSalePrice": 635.9388,
            "maxSalePrice": 2780,
            "minSalePrice": 5
          },
          {
            "fourthCategoryName": "粉底液",
            "metricDate": "2022-03",
            "monthSalePrice": 376.0687,
            "monthSaleCnt": 143367,
            "monthSaleAmount": 50482661.9364,
            "perPieceSalePrice": 352.1219,
            "maxSalePrice": 920,
            "minSalePrice": 4
          },
          {
            "fourthCategoryName": "粉底液",
            "metricDate": "2022-02",
            "monthSalePrice": 416.5071,
            "monthSaleCnt": 86186,
            "monthSaleAmount": 35587467.45,
            "perPieceSalePrice": 412.9147,
            "maxSalePrice": 920,
            "minSalePrice": 5.8
          },
          {
            "fourthCategoryName": "眼霜",
            "metricDate": "2022-01",
            "monthSalePrice": 770.0414,
            "monthSaleCnt": 82227,
            "monthSaleAmount": 59526457,
            "perPieceSalePrice": 723.9284,
            "maxSalePrice": 2765,
            "minSalePrice": 73.5
          },
          {
            "fourthCategoryName": "眼霜",
            "metricDate": "2022-02",
            "monthSalePrice": 768.6381,
            "monthSaleCnt": 82016,
            "monthSaleAmount": 61004530.0357,
            "perPieceSalePrice": 743.8125,
            "maxSalePrice": 2780,
            "minSalePrice": 9.5
          }
        ],
        "pageSize": 5,
        "page": 1,
        "total": 222,
        "time": 3174
      }
    }

    6. 状态码

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

    状态码 描述

    微信扫描二维码在线咨询