> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aibase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 竞品业务主题AI声量对比

> 查询指定品牌在指定时间范围内各业务主题下我方品牌与监测竞品的 AI 声量占比对比，按主题名称分组返回各品牌在该主题下的声量占比与监测问题数量，便于定位我方品牌声量落后的业务主题。

查询指定品牌在指定时间范围内各业务主题下我方品牌与监测竞品的 AI 声量占比对比，按主题名称分组返回各品牌在该主题下的声量占比与监测问题数量，便于定位我方品牌声量落后的业务主题。

> [!NOTE]
>
> **执行模式：SYNC · 实时请求。**
> 请求发出后服务端同步执行业务，结果直接在当前响应的 `data` 中返回，不存在异步任务、无需轮询、无需二次查询。

## 接口速查

| 项目 | 当前接口约定 |
| - | - |
| 接口状态 | 已上线 |
| 请求方式 | `POST` |
| 请求地址 | `https://geobaseapi.aibase.com/v1/openapi/execute` |
| 业务标识 | `competitor.topic.rate` |
| 执行模式 | **SYNC · 实时请求**（直接返回，无需轮询） |
| 身份认证 | Header `AIBase-API-Key` |
| 请求格式 | `application/json` |
| 返回结构 | 按主题名称（topicName）分组（键 → 统计数组），无数据时为空对象 `{}` |

## 请求头

**AIBase-API-Key** `string` *required*

开发者 API Key，例如 `AIBase_xxx`。用于身份认证、有效期与调用权限校验，请仅在服务端保存和使用。

**Content-Type** `string` *required*

固定为 `application/json`。

**AIBase-Request-Id** `string`

开发者自定义请求 ID，用于请求追踪；不传时系统自动生成 UUID。

## 请求体

**apiCode** `string` *required*

固定为 `competitor.topic.rate`。

**data** `object` *required*

业务请求参数对象。

**data.brandId** `string` *required*

品牌 ID。所属品牌 ID，为空返回 4001

**data.llmName** `string`

AI平台。按 AI 平台筛选，如 deepseek；不传返回全部平台

**data.startDate** `string`

开始日期。格式 yyyy-MM-dd；默认最近 7 天

**data.endDate** `string`

结束日期。格式 yyyy-MM-dd；默认今天，不能晚于今天

> [!NOTE]
>
> 时间范围规则：startDate/endDate 不传时默认查询最近 7 天；endDate 晚于今天会被自动截断为今天；起止时间跨度最大 6 个月；开始日期晚于结束日期将直接报错。

```bash cURL theme={null}
curl --location 'https://geobaseapi.aibase.com/v1/openapi/execute' \
  --header 'Content-Type: application/json' \
  --header 'AIBase-API-Key: AIBase_xxxxxxxxxxxxxxxx' \
  --header 'AIBase-Request-Id: req-20260924-001' \
  --data '{"apiCode":"competitor.topic.rate","data":{"brandId":"brand-001","startDate":"2026-09-01","endDate":"2026-09-23"}}'
```

```python Python theme={null}
import os
import requests

api_key = os.environ["AIBASE_API_KEY"]
headers = {
    "AIBase-API-Key": api_key,
    "Content-Type": "application/json",
    "AIBase-Request-Id": "req-20260924-001",
}

payload = {
  "apiCode": "competitor.topic.rate",
  "data": {
    "brandId": "brand-001",
    "startDate": "2026-09-01",
    "endDate": "2026-09-23"
  }
}

res = requests.post(
    "https://geobaseapi.aibase.com/v1/openapi/execute",
    headers=headers,
    json=payload,
    timeout=60,
)
res.raise_for_status()
body = res.json()

if body["code"] == 200:
    print(body["data"])
```

```javascript Node.js theme={null}
const payload = {
  "apiCode": "competitor.topic.rate",
  "data": {
    "brandId": "brand-001",
    "startDate": "2026-09-01",
    "endDate": "2026-09-23"
  }
};

const res = await fetch("https://geobaseapi.aibase.com/v1/openapi/execute", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "AIBase-API-Key": process.env.AIBASE_API_KEY,
    "AIBase-Request-Id": "req-20260924-001",
  },
  body: JSON.stringify(payload),
});

const body = await res.json();
if (body.code === 200) {
  console.log(body.data);
}
```

```java Java theme={null}
String body = """
{
  "apiCode": "competitor.topic.rate",
  "data": {
    "brandId": "brand-001",
    "startDate": "2026-09-01",
    "endDate": "2026-09-23"
  }
}
""";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://geobaseapi.aibase.com/v1/openapi/execute"))
    .header("Content-Type", "application/json")
    .header("AIBase-API-Key", "AIBase_xxxxxxxxxxxxxxxx")
    .header("AIBase-Request-Id", "req-20260924-001")
    .POST(BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, BodyHandlers.ofString());
System.out.println(response.body());
```

## 返回参数

业务结果位于 data，为按主题名称（topicName）分组的结构，每个主题对应该主题下各品牌（我方品牌与竞品）的 AI 声量统计数组。无数据时 data 为空对象 {}。

**\{topicName}\[].topicId** `string`

主题 ID。业务主题 ID。

**\{topicName}\[].topicName** `string`

主题名称。业务主题名称。

**\{topicName}\[].competitorName** `string`

品牌名称。我方品牌或竞品名称。

**\{topicName}\[].analysisType** `integer`

分析类型。1 我方品牌，2 竞争对手。

**\{topicName}\[].brandRate** `number`

AI 声量占比。该品牌在该主题下的 AI 声量占比（%）。

**\{topicName}\[].promptCount** `integer`

监测问题数量。该主题下的监测 AI 对话问题数量。

```json 200 (成功响应) theme={null}
{
  "code": 200,
  "msg": "成功",
  "data": {
    "品牌口碑": [
      {
        "topicId": "topic-001",
        "topicName": "品牌口碑",
        "competitorName": "我方品牌",
        "analysisType": 1,
        "brandRate": 20.1,
        "promptCount": 32
      },
      {
        "topicId": "topic-001",
        "topicName": "品牌口碑",
        "competitorName": "竞品A",
        "analysisType": 2,
        "brandRate": 25.6,
        "promptCount": 32
      }
    ],
    "产品对比": [
      {
        "topicId": "topic-002",
        "topicName": "产品对比",
        "competitorName": "竞品B",
        "analysisType": 2,
        "brandRate": 18.4,
        "promptCount": 20
      }
    ]
  },
  "timeStamp": 1788830174812
}
```

## 接入注意事项

1. apiCode 必须固定为 competitor.topic.rate。
2. brandId 为必填参数，为空返回 4001（所需参数不足）。
3. startDate/endDate 格式必须为 yyyy-MM-dd，默认最近 7 天，最大查询跨度 6 个月。
4. 返回结构为「主题名称 → 统计数组」的分组对象；无数据时 data 为空对象 {}，解析时做好空值兼容。
5. analysisType：1 为我方品牌，2 为竞争对手。
6. 下游查询异常会直接透传返回错误响应，不会包装为空数据。

> [accordion] Java 返回对象
>
> ```java theme={null}
> public class TopicBrandRate {
>     private String topicId;
>     private String topicName;
>     private String competitorName;
>     private Integer analysisType;
>     private BigDecimal brandRate;
>     private Integer promptCount;
> }
> ```
>
> 完整响应类型可表示为 `ReturnResult<Map<String, List<TopicBrandRate>>>`（`ReturnResult` 定义见 6.2.5）。

> [accordion] TypeScript 类型
>
> ```typescript theme={null}
> export interface TopicBrandRate {
>   topicId: string | null;
>   topicName: string | null;
>   competitorName: string | null;
>   analysisType: number;
>   brandRate: number | null;
>   promptCount: number;
> }
>
> export type CompetitorTopicRateResult = Record<string, TopicBrandRate[]>;
> ```
>
> 可按以上 TypeScript 类型定义解析响应数据。

> [!NOTE]
>
> 本页的 cURL 与 Java 示例来自官方接口文档；Python 与 Node.js 示例为等价转写，未经服务端联调，请以实际返回结果为准。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.