# Конкуренты

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/backlinks/competitors/live`

**Tags:** DataForSEO

Сайты, разделяющие ссылающиеся домены с одним `target`, отсортированные по числу общих доменов. Каждая строка содержит `target`, `rank` и `intersections` — количество общих ссылающихся доменов. `main_domain`, `exclude_large_domains` и `exclude_internal_backlinks` определяют, что учитывается. Это конкуренты по графу ссылок, а не поисковые конкуренты; для последних используйте `post_dataforseo_labs_google_serp_competitors_live`. Чтобы увидеть сами общие домены, используйте `post_dataforseo_backlinks_domain_intersection_live`.

### Справочные цены

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.0276.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Только справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "target": {
            "type": "string",
            "description": "<em>домен, поддомен или веб-страница, для которых нужно получить домены-конкуренты</em><br><strong>обязательное поле</strong><br>домен или поддомен указывается без <code>https://</code> и <code>www.</code><br>страница указывается абсолютным URL (включая <code>http://</code> или <code>https://</code>)"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>максимальное количество возвращаемых доменов</em><br>необязательное поле<br>значение по умолчанию: <code>100</code><br>максимальное значение: <code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>смещение в массиве результатов возвращаемых доменов</em><br>необязательное поле<br>значение по умолчанию: <code>0</code><br>если указать значение <code>10</code>, первые десять доменов в массиве результатов будут пропущены, а данные будут предоставлены для последующих страниц"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>массив параметров фильтрации результатов</em><br>необязательное поле<br><strong>можно добавить несколько фильтров сразу (не более 8)</strong><br>между условиями нужно указать логический оператор <code>and</code> или <code>or</code><br>поддерживаются следующие операторы:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>оператор <code>%</code> можно использовать с <code>like</code> и <code>not_like</code>, чтобы сопоставить любую строку из нуля или более символов<br>пример:<br><code>[\"rank\",\"&gt;\",\"100\"]</code><p><code>[[\"target\",\"like\",\"%forbes%\"],<br>\"and\",<br>[[\"rank\",\"&gt;\",\"100\"],\"or\",[\"intersections\",\"&gt;\",\"5\"]]]</code><p>Полный список возможных фильтров доступен <a href=\"/v3/backlinks/filters/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">здесь.</a>"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>правила сортировки результатов</em><br>необязательное поле<br>для сортировки результатов можно использовать те же значения, что и в массиве <code>filters</code><br>возможные типы сортировки:<br><code>asc</code> — результаты сортируются по возрастанию<br><code>desc</code> — результаты сортируются по убыванию<br>тип сортировки указывается через запятую<br>пример:<br><code>[\"rank,desc\"]</code><br><strong>в одном запросе можно задать не более трёх правил сортировки</strong><br>несколько правил сортировки разделяются запятой<br>пример:<br><code>[\"intersections,desc\",\"rank,asc\"]</code>"
          },
          "main_domain": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>указывает, будет ли в поиск включён только основной домен <code>target</code></em><br>необязательное поле<br>если задано <code>true</code>, в поиск будет включён только основной домен;<br>значение по умолчанию: <code>true</code>"
          },
          "exclude_large_domains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>указывает, будут ли крупные домены присутствовать в результатах</em><br>необязательное поле<br>если задано <code>true</code>, результаты с крупного домена (google.com, amazon.com и т. п.) будут исключены;<br>значение по умолчанию: <code>true</code>"
          },
          "exclude_internal_backlinks": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>указывает, исключаются ли из результатов внутренние обратные ссылки с поддоменов на <code>target</code></em><br>необязательное поле<br>если задано <code>true</code>, результаты не будут содержать данные о внутренних обратных ссылках с поддоменов того же домена, что и <code>target</code><br>если задано <code>false</code>, внутренние ссылки будут включены в результаты<br>значение по умолчанию: <code>true</code>"
          },
          "rank_scale": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>определяет шкалу, используемую для расчёта и отображения значений <code>rank</code>, <code>domain_from_rank</code> и <code>page_from_rank</code></em><br>необязательное поле<p>этот параметр позволяет выбрать, будут ли значения ранга представлены по шкале 0–100 или 0–1000<p>возможные значения:<br><code>one_hundred</code> — значения ранга отображаются по шкале 0–100<br><code>one_thousand</code> — значения ранга отображаются по шкале 0–1000<p>значение по умолчанию: <code>one_thousand</code><p>Как работает этот параметр и как рассчитываются метрики ранжирования, описано в <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">этой статье Help Center</a>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "filters": [
              "rank",
              ">",
              100
            ],
            "order_by": [
              "rank,desc"
            ],
            "limit": 5
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "filters": [
        "rank",
        ">",
        100
      ],
      "order_by": [
        "rank,desc"
      ],
      "limit": 5
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResponseInfo"
    }
  ]
}
```

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksCompetitorsLiveItem

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>домен конкурента</em>"
    },
    "rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг домена</em><br>ранг домена среди всех доменов в базе данных<br><code>rank</code> рассчитывается по методу ранжирования узлов в связанной базе данных — принципу, использованному в оригинальном алгоритме Google PageRank<br>Подробнее о метрике и способе её расчёта — в <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
    },
    "intersections": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>указывает количество пересечений обратных ссылок с <code>target</code>, указанным в POST-массиве</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее количество релевантных элементов в базе данных</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество элементов в массиве <code>items</code></em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveItem"
          }
        ]
      },
      "description": "<em>массив элементов</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "текущая версия API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "общий код состояния.\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks, возвращённых с ошибкой",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число элементов в массиве result",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "путь URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "содержит те же параметры, что вы указали в POST-запросе"
    }
  }
}
```
