プロダクト

参照

API

ブランドレーダーのプロンプトを更新

API のみ

PATCH/v3/management/brand-radar-prompts

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

クエリパラメータ

report_idstring必須

使用するレポートのID。AhrefsのブランドレーダーレポートのURLで確認できます：https://app.ahrefs.com/brand-radar/reports/#report_id#/...

outputstring

出力形式。

許可される値:jsoncsvxmlphp

リクエスト本文

promptsarray<string>Required

更新対象となるレポートのカスタムプロンプトの一覧。

最小:1

countries

プロンプトに適用する国に関する操作。

これらの国でもプロンプトを追跡します。

operationstringrequired

許可される値:add

countriesarray<string>required

許可される値:adaeafagaialamaoarasatauawazba…

tags

プロンプトに適用するタグ操作です。

プロンプトにタグを追加します。レポートにまだないタグは新規作成されます。

operationstringrequired

許可される値:add

tagsarray<string>required

応答

promptsarray<object>

countrystring

プロンプトの国。

created_atstring (date)

プロンプトが作成された日付。

promptstring

プロンプトのテキスト。

tagsarray<string>

プロンプトに割り当てられているタグです。

パラメータ

report_id必須

output

リクエスト本文

{
  "prompts": ["string"],
  "countries": {
      "operation": "add",
      "countries": ["ad"]
    },
  "tags": {
      "operation": "add",
      "tags": ["string"]
    }
}

API キー必須

リクエスト

curl "https://api.ahrefs.com/v3/management/brand-radar-prompts" \
  -X PATCH \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompts": ["string"],
  "countries": {
      "operation": "add",
      "countries": ["ad"]
    },
  "tags": {
      "operation": "add",
      "tags": ["string"]
    }
}'

import requests

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

response = requests.patch(url, headers=headers, json={
  "prompts": ["string"],
  "countries": {
      "operation": "add",
      "countries": ["ad"]
    },
  "tags": {
      "operation": "add",
      "tags": ["string"]
    }
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/brand-radar-prompts", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "prompts": ["string"],
  "countries": {
      "operation": "add",
      "countries": ["ad"]
    },
  "tags": {
      "operation": "add",
      "tags": ["string"]
    }
})
});

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

body := []byte(`{
  "prompts": ["string"],
  "countries": {
      "operation": "add",
      "countries": ["ad"]
    },
  "tags": {
      "operation": "add",
      "tags": ["string"]
    }
}`)
req, _ := http.NewRequest("PATCH", "https://api.ahrefs.com/v3/management/brand-radar-prompts", 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

{
  "prompts": [
    {
      "country": "string",
      "created_at": "string",
      "prompt": "string",
      "tags": ["string"]
    }
  ]
}