Brand Radar 报告

仅限 API

PATCH/v3/management/brand-radar-reports

对此端点的请求免费，不会消耗任何 API 单位。

查询参数

outputstring

输出格式。

允许的值:jsonphp

请求正文

prompts_frequencyarray<object>Required

要使用的提示词频率。

data_sourcestringrequired

要使用的数据源。

Allowed values:chatgptgeminiperplexitycopilot

frequencystringrequired

要使用的更新间隔。

Allowed values:dailyweeklymonthlyoff

report_idstringRequired

要使用的报告 ID。你可以在 Ahrefs 的 Brand Radar 报告 URL 中找到：https://app.ahrefs.com/brand-radar/reports/#report_id#/...

响应

reportsarray<object>

report_idstring

报告的唯一标识符。

report_namestring

报告名称。

created_atstring

报告的创建日期。

project_idinteger or null

报告关联的项目 ID。

prompts_frequencyarray<object>

一条包含字段 data_source（可能的值：chatgpt、copilot、gemini、perplexity）和 frequency（可能的值：daily、weekly、monthly、off）的记录。

参数

output

请求正文

{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "report_id": "string"
}

API密钥

请求

curl "https://api.ahrefs.com/v3/management/brand-radar-reports" \
  -X PATCH \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "report_id": "string"
}'

import requests

url = "https://api.ahrefs.com/v3/management/brand-radar-reports"
headers = {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.patch(url, headers=headers, json={
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "report_id": "string"
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/brand-radar-reports", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "report_id": "string"
})
});

const data = await response.json();
console.log(data);

body := []byte(`{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "report_id": "string"
}`)
req, _ := http.NewRequest("PATCH", "https://api.ahrefs.com/v3/management/brand-radar-reports", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer $AHREFS_API_KEY")
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

data, _ := io.ReadAll(resp.Body)
fmt.Println(string(data))

响应

200 OK

{
  "reports": [
    {
      "report_id": "string",
      "report_name": "string",
      "created_at": "string",
      "project_id": 0,
      "prompts_frequency": [
        {}
      ]
    }
  ]
}