跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.topify.ai/llms.txt

Use this file to discover all available pages before exploring further.

可见度趋势端点返回项目中每个活跃竞争对手的每日时间序列指标。可用于绘制品牌可见度、情感分析和位置随时间在不同 AI 服务商之间的变化情况。

获取可见度趋势

GET /projects/{project_id}/visibility
返回每个活跃竞争对手在所选 AI 服务商上的每日可见度、情感分析和位置值(取平均)。

路径参数

参数类型描述
project_idstring (UUID)项目 ID

查询参数

参数类型默认值描述
duration_daysinteger7回溯天数
date_fromstring起始日期(YYYY-MM-DD
date_tostring结束日期(YYYY-MM-DD
providersstring以逗号分隔的 AI 服务商筛选
curl "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/visibility?duration_days=7" \
  -H "X-API-Key: tk_live_..."

响应

{
  "success": true,
  "data": {
    "dates": ["2026-02-28", "2026-03-01", "2026-03-02", "2026-03-03"],
    "period": "2026-02-28 to 2026-03-03",
    "series": [
      {
        "competitor_id": "00000000-0000-0000-0000-000000000000",
        "name": "Acme Corp",
        "website": "https://acme.com",
        "icon_url": "https://logo.clearbit.com/acme.com",
        "is_own_brand": true,
        "visibility": [82.5, 85.0, 83.2, 86.1],
        "sentiment": [70.0, 72.0, 71.5, 73.0],
        "position": [1.8, 1.6, 1.9, 1.5]
      },
      {
        "competitor_id": "c1d2e3f4-...",
        "name": "Competitor A",
        "website": "https://competitor-a.com",
        "icon_url": "https://logo.clearbit.com/competitor-a.com",
        "is_own_brand": false,
        "visibility": [60.0, 62.5, null, 65.0],
        "sentiment": [55.0, 58.0, null, 60.0],
        "position": [3.2, 3.0, null, 2.8]
      }
    ]
  }
}

VisibilityTrendsResponse 字段

字段类型描述
datesstring[]已排序的日期字符串,格式为 YYYY-MM-DD
periodstring人类可读的日期范围(例如 2026-02-28 to 2026-03-03
seriesCompetitorSeries[]每个活跃竞争对手对应一项

CompetitorSeries 字段

字段类型可空描述
competitor_idstring (UUID)No竞争对手 ID
namestringNo竞争对手品牌名称
websitestringNo竞争对手网站 URL
icon_urlstringYes主要 logo URL
is_own_brandbooleanNo如果这是您自己的品牌则为 true
visibilityfloat[]Nodates 对齐的每日可见度评分。无数据的日期为 null
sentimentfloat[]Nodates 对齐的每日情感分析评分。无数据的日期为 null
positionfloat[]Nodates 对齐的每日位置值。无数据的日期为 null
当同一天有多个 AI 服务商的数据时,会取平均值。null 表示当天该竞争对手没有收集到数据。

应用场景

将每个竞争对手作为一条线绘制在时间序列图上。dates 数组提供 x 轴标签,每个 series 的 visibilitysentimentposition 数组提供 y 轴值。