Продукти

Довідник

API

Конкуренти

Лише API

POST/v3/management/project-competitors

Запити до цього ендпойнта безплатні й не витрачають жодних одиниць API.

Параметри запиту

project_idintegerОбов’язково

Унікальний ідентифікатор Проєкту. Його можна знайти в URL вашого проєкту Rank Tracker в Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Тіло запиту

competitorsarray<object>Required

Список конкурентів для додавання.

urlstringrequired

URL-адреса цілі Проєкту.

modestringrequired

Область дії цілі.

Allowed values:exactprefixdomainsubdomains

Відповіді

competitorsarray<object>

urlstring

URL цільового ресурсу проєкту.

modestring

Область охоплення цілі. Можливі значення: exact, prefix, domain, subdomains.

Параметри

project_idОбов’язково

output

Тіло запиту

{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}

Ключ API

Запит

curl "https://api.ahrefs.com/v3/management/project-competitors" \
  -X POST \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}'

import requests

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

response = requests.post(url, headers=headers, json={
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/project-competitors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
})
});

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

body := []byte(`{
  "competitors": [
    {
      "url": "string",
      "mode": "exact"
    }
  ]
}`)
req, _ := http.NewRequest("POST", "https://api.ahrefs.com/v3/management/project-competitors", 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

{
  "competitors": [
    {
      "url": "string",
      "mode": "string"
    }
  ]
}