> ## 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.

# 品牌提及情况

> 查询指定品牌在指定时间范围内的品牌提及情况，返回品牌相关 URL 总数及其在官网、仅提及品牌、品牌与竞品共同提及三类构成下的数量与占比。

查询指定品牌在指定时间范围内的品牌提及情况，返回品牌相关 URL 总数及其在官网、仅提及品牌、品牌与竞品共同提及三类构成下的数量与占比。

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

## 接口速查

| 项目 | 当前接口约定 |
| - | - |
| 接口状态 | 已上线 |
| 请求方式 | `POST` |
| 请求地址 | `https://geobaseapi.aibase.com/v1/openapi/execute` |
| 业务标识 | `source.brand.citation.overview` |
| 执行模式 | **SYNC · 实时请求**（直接返回，无需轮询） |
| 身份认证 | Header `AIBase-API-Key` |
| 请求格式 | `application/json` |
| 返回结构 | 对象（`data` 为单个统计对象） |

## 请求头

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

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

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

固定为 `application/json`。

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

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

## 请求体

**apiCode** `string` *required*

固定为 `source.brand.citation.overview`。

**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":"source.brand.citation.overview","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": "source.brand.citation.overview",
  "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": "source.brand.citation.overview",
  "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": "source.brand.citation.overview",
  "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，为单个汇总对象，返回品牌相关 URL 的提及构成与占比。聚合查询恒返回一条记录；无数据时 brandTotalCount 为 0，各占比字段可能为 null。

**brandTotalCount** `integer`

品牌相关 URL 总数。与品牌相关的 URL 总数。

**officialBrandCount** `integer`

官网 URL 数量。品牌官网相关的 URL 数量。

**officialBrandRate** `number`

官网占比。官网 URL 占品牌相关 URL 总数的比例（%）。

**onlyBrandCount** `integer`

仅提及品牌 URL 数量。仅提及本品牌、未涉及竞品的 URL 数量。

**onlyBrandRate** `number`

仅提及品牌占比。仅提及品牌 URL 占比（%）。

**brandCompetitorCount** `integer`

品牌与竞品共同提及 URL 数量。同时提及本品牌与竞品的 URL 数量。

**brandCompetitorRate** `number`

品牌与竞品共同提及占比。共同提及 URL 占比（%）。

```json 200 (成功响应) theme={null}
{
  "code": 200,
  "msg": "成功",
  "data": {
    "brandTotalCount": 132,
    "officialBrandCount": 28,
    "officialBrandRate": 21.21,
    "onlyBrandCount": 76,
    "onlyBrandRate": 57.58,
    "brandCompetitorCount": 28,
    "brandCompetitorRate": 21.21
  },
  "timeStamp": 1788830174812
}
```

## 接入注意事项

1. apiCode 必须固定为 source.brand.citation.overview。
2. brandId 为必填参数，为空返回 4001（所需参数不足）。
3. startDate/endDate 格式必须为 yyyy-MM-dd，默认最近 7 天，最大查询跨度 6 个月。
4. 返回为单个汇总对象；无数据时 brandTotalCount 为 0，各占比字段可能为 null。
5. 各占比字段均以 brandTotalCount 为分母，分母为 0 时占比为 null。

> [accordion] Java 返回对象
>
> ```java theme={null}
> public class BrandCitationOverview {
>     private Integer brandTotalCount;
>     private Integer officialBrandCount;
>     private BigDecimal officialBrandRate;
>     private Integer onlyBrandCount;
>     private BigDecimal onlyBrandRate;
>     private Integer brandCompetitorCount;
>     private BigDecimal brandCompetitorRate;
> }
> ```
>
> 完整响应类型可表示为 `ReturnResult<BrandCitationOverview>`（`ReturnResult` 定义见 6.2.5）。

> [accordion] TypeScript 类型
>
> ```typescript theme={null}
> export interface BrandCitationOverview {
>   brandTotalCount: number;
>   officialBrandCount: number;
>   officialBrandRate: number | null;
>   onlyBrandCount: number;
>   onlyBrandRate: number | null;
>   brandCompetitorCount: number;
>   brandCompetitorRate: number | null;
> }
> ```
>
> 可按以上 TypeScript 类型定义解析响应数据。

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


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