本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.indicator.brand.allBrand.byVersion
请求方式：POST
描述：通过该接口可查询品牌知识码表对应版本号的品牌知识数据
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | RequestBrandVersionFilters | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | ResponseData | (见接口示例) | 返回数据结果，包含meta、dataset |
| message | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
4. 数据结构 #
4.1 RequestBrandIndicatorFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| versionNum | 否 | string | VPPK202306004 | 品牌版本号，默认不传查最新的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 BrandVersionVO #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| name | 否 | string | "雅诗兰黛" | 品牌名 |
| id | 否 | integer | 9 | 品牌id |
| itemId | 否 | string | "56" | 品牌itemId |
| url | 否 | string | "https://osscdn.datastory.com.cn/brand_picture/赫莲娜.jpg" | 品牌图url |
| keywords | 否 | array | ["HELENA RUBINSTEIN","Helena Rubinstein","Helena rubinstein","helena rubinstein","赫莲娜"] | 品牌别名 |
| type | 否 | string | "品牌" | 类型 |
| recallWord | 否 | string | "" | 召回词 |
| recallFilterWord | 否 | string | 2 | 召回过滤词 |
| matchRule | 否 | string | "新闻公关" | 匹配规则 |
| filterRule | 否 | string | 2 | 过滤规则 |
| ruleSentenceScopeLimit | 否 | string | "" | 词距规则范围限制 |
| categoryDomains | 否 | array | ["美妆行业库"] | 行业库 |
| nameEn | 否 | string | "" | 英文名 |
| brandGrade | 否 | string | "高端" | 品牌级别 |
| fragranceDim | 否 | string | "" | 品牌调性 |
| isCoreBrand | 否 | int | 1 | 是否核心品牌，1：是 0：否 |
| originCountry | 否 | string | "" | 来源国家 |
| originCountryType | 否 | string | "" | 来源国家类型 |
| corporation | 否 | string | "" | 合作品牌 |
| ownCategory | 否 | string | "" | 自有类别 |
5. 示例 #
示例1 查看品牌在每个阵地每天的声量趋势 #
输入示例
{
"filters": {
"versionNum": "VPPK202306004"
}
}返回示例
{
"code": 20000,
"message": "接口返回成功！",
"data": {
"meta": {
"datasetType": "standard",
"schema": [
{
"name": "id",
"alias": "品牌id",
"visibility": "Queryable",
"type": "int"
},
{
"name": "itemId",
"alias": "品牌itemId",
"visibility": "Queryable",
"type": "string"
},
{
"name": "name",
"alias": "品牌名称",
"visibility": "Queryable",
"type": "string"
},
{
"name": "url",
"alias": "url",
"visibility": "Queryable",
"type": "string"
},
{
"name": "updateTimestamp",
"alias": "updateTimestamp",
"visibility": "Queryable",
"type": "int"
},
{
"name": "keywords",
"alias": "keywords",
"visibility": "Queryable",
"type": "object"
},
{
"name": "wordList",
"alias": "wordList",
"visibility": "Queryable",
"type": "string"
},
{
"name": "type",
"alias": "type",
"visibility": "Queryable",
"type": "string"
},
{
"name": "domains",
"alias": "domains",
"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": "categoryDomains",
"alias": "categoryDomains",
"visibility": "Queryable",
"type": "object"
},
{
"name": "industry",
"alias": "industry",
"visibility": "Queryable",
"type": "string"
},
{
"name": "nameEn",
"alias": "nameEn",
"visibility": "Queryable",
"type": "string"
},
{
"name": "brandGrade",
"alias": "brandGrade",
"visibility": "Queryable",
"type": "string"
},
{
"name": "fragranceDim",
"alias": "fragranceDim",
"visibility": "Queryable",
"type": "string"
},
{
"name": "isCoreBrand",
"alias": "isCoreBrand",
"visibility": "Queryable",
"type": "int"
},
{
"name": "otherInfo",
"alias": "otherInfo",
"visibility": "Queryable",
"type": "string"
},
{
"name": "originCountry",
"alias": "originCountry",
"visibility": "Queryable",
"type": "string"
},
{
"name": "originCountryType",
"alias": "originCountryType",
"visibility": "Queryable",
"type": "string"
},
{
"name": "corporation",
"alias": "corporation",
"visibility": "Queryable",
"type": "string"
},
{
"name": "ownCategory",
"alias": "ownCategory",
"visibility": "Queryable",
"type": "string"
}
]
},
"dataset": {
"total": 2462,
"rowdata": [
{
"id": 36937,
"itemId": "7ce65611dfee888691d0d672f603ea65",
"name": "9又4分之3",
"updateTimestamp": 1685980800000,
"keywords": [
"9/34",
"93/4",
"9又4分之3"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 6172,
"itemId": "4f5a22c5a3b018c60b5858044fa7ad90",
"name": "A'Pieu",
"updateTimestamp": 1685980800000,
"keywords": [
"A Pieu",
"A'Pieu",
"APieu"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 37450,
"itemId": "47a63c012ea0524de7fcff01b2e7de68",
"name": "AFK",
"updateTimestamp": 1685980800000,
"keywords": [
"AFK"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 4891,
"itemId": "57c246c4dc237d3798e00a6e31e9c8fe",
"name": "AHC",
"url": "https://osscdn.datastory.com.cn/brand_picture/AHC.jpg",
"updateTimestamp": 1685980800000,
"keywords": [
"A.H.C",
"AHC",
"Ahc",
"ahc",
"爱和纯"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "AHC",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 37458,
"itemId": "dfc3e800fd25a76ce7c430fb73d9d3fb",
"name": "BAUM",
"updateTimestamp": 1685980800000,
"keywords": [
"BAUM"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "高端",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 16263,
"itemId": "ae59ff17bbc3ae0517bde7b9165d9e4e",
"name": "BECCA",
"url": "https://osscdn.datastory.com.cn/brand_picture/BECCA.jpg",
"updateTimestamp": 1685980800000,
"keywords": [
"BECCA"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 4713,
"itemId": "f68b1b4e481029c34bb62514b743d54e",
"name": "BM肌活",
"url": "https://osscdn.datastory.com.cn/brand_picture/肌活.jpg",
"updateTimestamp": 1685980800000,
"keywords": [
"BM肌活",
"Bio MESO",
"Bio-MESO",
"BioMESO"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 8460,
"itemId": "ce10535854781a8da561d6edb4f87613",
"name": "Beaba",
"url": "https://osscdn.datastory.com.cn/brand_picture/碧芭.jpg",
"updateTimestamp": 1685980800000,
"keywords": [
"Beaba",
"碧芭",
"碧芭宝贝"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 37436,
"itemId": "d26ea32cc900dcd2531174d1981f46dc",
"name": "Bellapierre",
"updateTimestamp": 1685980800000,
"keywords": [
"Bellapierre"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
},
{
"id": 16699,
"itemId": "a7b4fd10339f3c2cf0763c1ea0cb0413",
"name": "Club",
"updateTimestamp": 1685980800000,
"keywords": [
"Club",
"club"
],
"type": "品牌",
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"nameEn": "",
"brandGrade": "大众",
"fragranceDim": "",
"isCoreBrand": 0
}
}
}
}
}