ブランドレーダーのレポート

API のみ

POST/v3/management/brand-radar-reports

このエンドポイントへのリクエストは無料で、APIユニットを消費しません。

クエリパラメータ

outputstring

出力形式。

許可される値:jsonphp

リクエスト本文

prompts_frequencyarray<object>

使用するプロンプトの頻度。

data_sourcestringrequired

使用するデータソースです。

Allowed values:chatgptgeminiperplexitycopilot

frequencystringrequired

使用する更新間隔です。

Allowed values:dailyweeklymonthlyoff

project_idinteger

使用するプロジェクトのID。

namestring

レポートの名前。

marketarray<string>

ブランドのニッチ市場のリスト。

competitorsarray<string>

貴社ブランドの競合他社のリストです。

brandarray<string>

貴社ブランドのリストです。brand、competitors、market のうち少なくとも1つは空でない必要があります。

応答

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"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}

API キー

リクエスト

curl "https://api.ahrefs.com/v3/management/brand-radar-reports" \
  -X POST \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["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.post(url, headers=headers, json={
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
})
print(response.json())

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

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

body := []byte(`{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}`)
req, _ := http.NewRequest("POST", "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": [
        {}
      ]
    }
  ]
}