本页内容
1.接口URL #
https://open.datastory.com.cn/api/datastory.ecommerce.brandcategory.whitelist.list
请求方式：POST
描述：通过该接口可查看白名单内的数据详情，具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限效验标识 | |
| filters | 是 | array of RequestBrandCategoryWhitelistFilters | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 | |
| page | 否 | integer | 1 | 分页查询的页码，默认1 | |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数，默认20 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | Array of ResponseDataOfBrandCategoryWhitelistDTO | (见接口示例) | 查询过滤条件 |
| msg | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
| success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestBrandCategoryWhitelistFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| brandId | 否 | integer | 68 | 品牌名ID |
| brandName | 否 | string | "小米" | 品牌名称 |
| firstCatId | 否 | integer | "3" | 一级品类ID |
| firstCatName | 否 | string | "美妆个护" | 一级品类名称 |
4.2ResponseDataOfBrandCategoryWhitelistDTO #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | array | [Array of BrandCategoryWhitelistDTO,Array of BrandCategoryWhitelistDTO] | （见接口请求示例） 返回数据集，不同接口返回结果的格式不一样 |
| meta | 否 | array | "list" | 返回数据格式：list、aggregation、graph |
| page | 否 | integer | 1 | 分页查询的页码 |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
| time | 否 | integer | "955" | 查询总耗时，单位毫秒 |
| total | 否 | integer | "34500230" | 查询数据总量 |
4.2.1BrandCategoryWhitelistDTO #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| brandId | 否 | integer | 68 | 品牌名ID |
| brandName | 否 | string | "小米" | 品牌名称 |
| firstCatId | 否 | integer | "3" | 一级品类ID |
| firstCatName | 否 | string | "美妆个护" | 一级品类名称 |
5. 示例 #
示例1 查看行业下品牌的信息 #
根据某个行业和品牌来查看相应的基础信息。
输入示例
{
"appkey": "predeploy",
"filters": {
"brandName": "兰蔻",
"firstCatName": "美妆个护"
},
"openStrategy": false,
"page": 1,
"pageSize": 20
}输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功！",
"data": {
"meta": {
"datasetType": "list"
},
"dataset": [
{
"brandId": 4848,
"firstCatId": 665,
"brandName": "兰蔻",
"firstCatName": "美妆个护"
}
],
"total": 1,
"time": 82
}
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
| 状态码 | 描述 |
|---|---|