Brand Radar Reports

Nur API

POST/v3/management/brand-radar-reports

Anfragen an diesen Endpunkt sind kostenlos und verbrauchen keine API-Einheiten.

Query-Parameter

outputstring

Das Ausgabeformat.

Zulässige Werte:jsonphp

Anfrage-Body

prompts_frequencyarray<object>

Die zu verwendende Prompt-Frequenz.

data_sourcestringrequired

Die zu verwendende Datenquelle.

Allowed values:chatgptgeminiperplexitycopilot

frequencystringrequired

Das zu verwendende Aktualisierungsintervall.

Allowed values:dailyweeklymonthlyoff

project_idinteger

Die ID des zu verwendenden Projekts.

namestring

Der Name des Reports.

marketarray<string>

Eine Liste der Nischenmärkte deiner Marken.

competitorsarray<string>

Eine Liste der Wettbewerber Ihrer Marken.

brandarray<string>

Eine Liste Ihrer Marken. Mindestens eines von Marke, Wettbewerbern oder Markt darf nicht leer sein.

Antworten

reportsarray<object>

report_idstring

Der eindeutige Identifikator des Reports.

report_namestring

Der Name des Reports.

created_atstring

Das Datum, an dem der Report erstellt wurde.

project_idinteger or null

Die ID des Projekts, mit dem der Report verknüpft ist.

prompts_frequencyarray<object>

Ein Datensatz mit den Feldern data_source (mögliche Werte: chatgpt, copilot, gemini, perplexity) und frequency (mögliche Werte: daily, weekly, monthly, off).

Parameter

output

Anfrage-Body

{
  "prompts_frequency": [
    {
      "data_source": "chatgpt",
      "frequency": "daily"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}

API-Key

Anfrage

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))

Antwort

200 OK

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