本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.indicator.category.allCategory.byVersion
请求方式：POST
描述：通过该接口可查询品类知识码表对应版本号的品类知识数据
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | RequestCategoryVersionFilters | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | ResponseData | (见接口示例) | 返回数据结果，包含meta、dataset |
| message | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
4. 数据结构 #
4.1 RequestCategoryIndicatorFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| versionNum | 否 | string | VPLK202306004 | 品类版本号，默认不传查最新的Naja版本 |
4.2 ResponseData #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | ResponseDataset | (见接口请求示例) | 返回数据集，不同接口返回结果的格式不一样 |
| dorisTime | 否 | integer | "458" | 查询Doris耗时，单位毫秒 |
| meta | 否 | object | "list" | 返回数据的描述信息，主要是字段信息，非方舟接口，请忽略 |
| time | 否 | integer | "955" | 查询总耗时，单位毫秒 |
4.2.1 ResponseDataset #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| total | 否 | integer | "34500230" | 查询数据总量 |
| currentPage | 否 | integer | 1 | 分页查询的页码 |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
| rowdata | 否 | BrandVersionVO | (见接口请求示例) | 返回数据集，不同接口返回结果的格式不一样 |
4.2.2 CategoryVersionVO #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| key | 否 | string | "美妆个护" | 品类名 |
| id | 否 | integer | 9 | 品类id |
| itemId | 否 | string | "56" | 品类itemId |
| level | 否 | integer | 1 | 品类层级 |
| url | 否 | string | "" | 品类图url |
| wordList | 否 | array | [""] | 品类别名 |
| type | 否 | string | "品类" | 类型 |
| firstCatName | 否 | string | "" | 一级品类 |
| secondCatName | 否 | string | "" | 二级品类 |
| thirdCatName | 否 | string | "" | 三级品类 |
| fourthCatName | 否 | string | "" | 四级品类 |
| fifthCatName | 否 | string | "" | 五级品类 |
| recallWord | 否 | string | "" | 召回词 |
| recallFilterWord | 否 | string | 2 | 召回过滤词 |
| matchRule | 否 | string | "新闻公关" | 匹配规则 |
| filterRule | 否 | string | 2 | 过滤规则 |
| ruleSentenceScopeLimit | 否 | string | "" | 词距规则范围限制 |
| categoryDomains | 否 | array | ["美妆行业库"] | 行业库 |
5. 示例 #
示例1 查看品类知识数据 #
输入示例
{
"filters": {
"versionNum": "VPLK202306004"
}
}返回示例
{
"code": 20000,
"message": "接口返回成功！",
"data": {
"meta": {
"datasetType": "standard",
"schema": [
{
"name": "id",
"alias": "knwlId 知识id",
"visibility": "Queryable",
"type": "int"
},
{
"name": "key",
"alias": "key",
"visibility": "Queryable",
"type": "string"
},
{
"name": "standardName",
"alias": "standardName",
"visibility": "Queryable",
"type": "string"
},
{
"name": "level",
"alias": "level",
"visibility": "Queryable",
"type": "int"
},
{
"name": "industry",
"alias": "industry",
"visibility": "Queryable",
"type": "string"
},
{
"name": "url",
"alias": "url",
"visibility": "Queryable",
"type": "string"
},
{
"name": "type",
"alias": "type",
"visibility": "Queryable",
"type": "string"
},
{
"name": "firstCatName",
"alias": "primary 一级品类",
"visibility": "Queryable",
"type": "string"
},
{
"name": "secondCatName",
"alias": "secondary 二级品类",
"visibility": "Queryable",
"type": "string"
},
{
"name": "thirdCatName",
"alias": "tertiary 三级品类",
"visibility": "Queryable",
"type": "string"
},
{
"name": "fourthCatName",
"alias": "quatermary 四级品类",
"visibility": "Queryable",
"type": "string"
},
{
"name": "fifthCatName",
"alias": "quinary 五级品类",
"visibility": "Queryable",
"type": "string"
},
{
"name": "firstCatId",
"alias": "firstCatId",
"visibility": "Queryable",
"type": "int"
},
{
"name": "secondCatId",
"alias": "secondCatId",
"visibility": "Queryable",
"type": "int"
},
{
"name": "thirdCatId",
"alias": "thirdCatId",
"visibility": "Queryable",
"type": "int"
},
{
"name": "fourthCatId",
"alias": "fourthCatId",
"visibility": "Queryable",
"type": "int"
},
{
"name": "keyword",
"alias": "keyword",
"visibility": "Queryable",
"type": "string"
},
{
"name": "recallWord",
"alias": "recallWord",
"visibility": "Queryable",
"type": "string"
},
{
"name": "recallFilterWord",
"alias": "recallFilterWord",
"visibility": "Queryable",
"type": "string"
},
{
"name": "matchRule",
"alias": "matchRule",
"visibility": "Queryable",
"type": "string"
},
{
"name": "filterRule",
"alias": "filterRule",
"visibility": "Queryable",
"type": "string"
},
{
"name": "ruleSentenceScopeLimit",
"alias": "ruleSentenceScopeLimit",
"visibility": "Queryable",
"type": "string"
},
{
"name": "wordList",
"alias": "关键词",
"visibility": "Queryable",
"type": "object"
},
{
"name": "domain",
"alias": "domain",
"visibility": "Queryable",
"type": "string"
},
{
"name": "categoryDomains",
"alias": "行业库",
"visibility": "Queryable",
"type": "object"
}
]
},
"dataset": {
"total": 9584,
"rowdata": [
{
"id": 1,
"key": "食品饮料",
"standardName": "食品饮料",
"level": 1,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": null,
"thirdCatName": null,
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": null,
"secondCatId": null,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": null,
"categoryDomains": [
"食品行业库"
]
},
{
"id": 2,
"key": "食品饮料其他",
"standardName": "食品饮料其他",
"level": 2,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "食品饮料其他",
"thirdCatName": null,
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": null,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"果蔬",
"水果",
"海鲜",
"美食",
"蔬菜",
"食品",
"食品饮料其他"
],
"categoryDomains": [
"人工运营"
]
},
{
"id": 3,
"key": "饮料",
"standardName": "饮料",
"level": 2,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": null,
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": null,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": null,
"categoryDomains": [
"食品行业库"
]
},
{
"id": 4,
"key": "饮料其他",
"standardName": "饮料其他",
"level": 3,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "饮料其他",
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"冰饮",
"冰饮料",
"冷饮",
"夏日冰饮",
"夏日饮品",
"无糖饮料",
"柠檬水",
"柠檬蜂蜜水",
"热饮",
"甜饮料",
"自制饮品",
"蜂蜜水",
"软饮料",
"飲品",
"饮品",
"饮品料",
"饮料",
"饮料其他",
"饮料品"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 6,
"key": "茶饮料",
"standardName": "茶饮料",
"level": 3,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": null,
"categoryDomains": [
"食品行业库"
]
},
{
"id": 7,
"key": "茶饮料其他",
"standardName": "茶饮料其他",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "茶饮料其他",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"冰茶",
"冷泡茶",
"冷萃茶",
"汽茶",
"碳酸茶",
"茶饮",
"茶饮品",
"茶饮料",
"茶饮料其他",
"蜜茶",
"饮品茶"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 8,
"key": "绿茶饮料",
"standardName": "绿茶饮料",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "绿茶饮料",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"碧螺春",
"绿茶",
"绿茶饮",
"绿茶饮料",
"茉莉绿茶",
"龙井茶"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 9,
"key": "红茶饮料",
"standardName": "红茶饮料",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "红茶饮料",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"伯爵红茶",
"冰红茶",
"单丛茶",
"无糖冰红茶",
"红茶",
"红茶饮",
"红茶饮料"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 10,
"key": "果汁茶饮料",
"standardName": "果汁茶饮料",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "果汁茶饮料",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"冻柠茶",
"山楂果茶",
"手打柠檬茶",
"果汁茶",
"果汁茶饮料",
"果茶",
"柚子茶",
"柠檬百香果茶",
"柠檬红茶",
"柠檬绿茶",
"柠檬茶",
"桑葚茶",
"水果茶",
"油柑茶",
"白桃乌龙茶",
"百香果茶",
"苦瓜柠檬茶",
"荔枝红茶",
"葡萄乌龙茶",
"蜂蜜柚子茶",
"蜜桃乌龙茶",
"金桔柠檬茶",
"金桔百香果茶",
"青提香乌龙茶",
"青梅绿茶",
"鲜果茶",
"鸭屎香柠檬茶"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 11,
"key": "奶茶饮料",
"standardName": "奶茶饮料",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "奶茶饮料",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"丝袜奶茶",
"乌龙奶茶",
"乳茶",
"冰奶茶",
"奶绿",
"奶茶",
"奶茶饮料",
"折耳根奶茶",
"抹茶拿铁",
"椰果奶茶",
"波波奶茶",
"波霸奶茶",
"泰式奶茶",
"港式奶茶",
"烤奶",
"烧仙草",
"焦糖奶茶",
"牛乳茶",
"珍珠奶茶",
"红茶拿铁",
"红茶玛奇朵",
"红豆奶茶",
"芋圆奶茶",
"轻乳茶",
"青团奶茶"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 12,
"key": "草本茶饮料",
"standardName": "草本茶饮料",
"level": 4,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "茶饮料",
"fourthCatName": "草本茶饮料",
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": 6,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": [
"养生花茶",
"养生茶",
"养颜花茶",
"冬瓜茶",
"决明子茶",
"凉茶",
"功夫茶",
"大益茶",
"大麦茶",
"枸杞茶",
"桂花茶",
"洛神花茶",
"清凉茶",
"滇红茶",
"玉米须茶",
"玫瑰花茶",
"玫瑰茶",
"祛湿茶",
"红枣枸杞茶",
"红枣茶",
"红豆薏米茶",
"红豆饮",
"罗汉果茶",
"胖大海菊花茶",
"芡实茶",
"花果茶",
"花茶",
"花草茶",
"茉莉清茶",
"茉莉花茶",
"茉莉茶",
"茉莉蜜茶",
"草本植物茶",
"草本茶",
"草本茶饮料",
"荷叶茶",
"菊花决明子茶",
"菊花枸杞茶",
"菊花茶",
"蒲公英茶",
"薏米芡实茶",
"薏米茶",
"豆饮",
"金银花",
"金银花茶",
"铁观音茶",
"黑豆饮"
],
"categoryDomains": [
"食品行业库"
]
},
{
"id": 13,
"key": "碳酸饮料",
"standardName": "碳酸饮料",
"level": 3,
"industry": "",
"url": "",
"type": "品类",
"firstCatName": "食品饮料",
"secondCatName": "饮料",
"thirdCatName": "碳酸饮料",
"fourthCatName": null,
"fifthCatName": null,
"firstCatId": 1,
"secondCatId": 3,
"thirdCatId": null,
"fourthCatId": null,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"wordList": null,
"categoryDomains": [
"食品行业库"
]
}
}
}
}
}