# Ссылки

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/links`

**Tags:** DataForSEO

Все ссылки, найденные во время обхода, по `id`. Фильтруйте через `page_from` и `page_to`, чтобы получить ссылки из одной страницы или на неё. Возвращает `total_items_count`, `items_count`, `items` и `search_after_token` для постраничной выдачи — используйте его вместо `offset` после первых страниц. Читает завершённый обход, поэтому нужен `id` из `post_dataforseo_on_page_submit`, и возвращает `crawl_progress` и `crawl_status` со значениями `max_crawl_pages`, `pages_in_queue` и `pages_crawled` — проверяйте их, прежде чем доверять небольшому результату: у ещё идущего обхода просто меньше данных. 💰 Бесплатно на стороне upstream: запрос к завершённому обходу ничего не стоит, платить нужно только за сам обход.

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

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.012.
- Справочный множитель для клиента: 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": {
          "id": {
            "type": "string",
            "description": "<em>ID задачи</em><br><strong>обязательное поле</strong><br>этот ID можно получить в ответе эндпоинта <a href=\"https://docs.dataforseo.com/v3/on_page/task_post/\">Task POST</a><br>пример:<br>\"07131248-1535-0216-1000-17384017ad04\""
          },
          "page_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>относительный URL страницы</em><br>необязательное поле<br>при использовании этого поля ответ API будет содержать только ссылки с указанной страницы<br>обратите внимание, что в этом поле можно указывать только относительные URL"
          },
          "page_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>относительный URL страницы</em><br>необязательное поле<br>при использовании этого поля ответ API будет содержать только внутренние ссылки, ведущие на указанную страницу<br>обратите внимание, что в этом поле можно указывать только относительные URL"
          },
          "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>2000000</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><br>оператор <code>%</code> можно использовать с <code>like</code> и <code>not_like</code> для сопоставления любой строки длиной от нуля символов<br>пример:<br><code>[\"direction\",\"=\",\"external\"]</code><p><code>[[\"domain_to\",\"&lt;&gt;\",\"example.com\"],<br>\"and\",<br>[\"link_from\",\"not_like\",\"%example.com/blog%\"]]</code><p><code>[[\"direction\",\"=\",\"external\"],<br>\"and\",<br>[[\"link_from\",\"like\",\"%example.com/blog%\"],\"or\",[\"link_from\",\"like\",\"%example.com/help%\"]]]</code><p>Полный список возможных фильтров доступен <a href=\"/v3/on_page/filters_and_thresholds/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">по этой ссылке.</a>"
          },
          "search_after_token": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>токен для последующих запросов</em><br>необязательное поле<br>предоставляется в том же поле ответа на каждый запрос;<br>используйте этот параметр, чтобы избежать тайм-аутов при получении более <code>20,000</code> результатов в одном запросе;<br>указав уникальное значение <code>search_after_token</code> из массива ответа, вы получите последующие результаты исходной задачи;<br>значения <code>search_after_token</code> уникальны для каждой последующей задачи;<br><strong>Примечание:</strong> если в запросе указан <code>search_after_token</code>, все остальные параметры должны совпадать с предыдущим запросом"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "id": "07281559-0695-0216-0000-c269be8b7592",
            "page_from": "/apis/google-trends-api",
            "filters": [
              [
                "dofollow",
                "=",
                true
              ],
              "and",
              [
                "direction",
                "=",
                "external"
              ]
            ],
            "limit": 10
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "07281559-0695-0216-0000-c269be8b7592",
      "page_from": "/apis/google-trends-api",
      "filters": [
        [
          "dofollow",
          "=",
          true
        ],
        "and",
        [
          "direction",
          "=",
          "external"
        ]
      ],
      "limit": 10
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseOnPageLinkItem

`#/components/schemas/Response36Afe1097B20_BaseOnPageLinkItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "domain_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылающийся домен</em><br>ссылка была найдена на этом домене"
    },
    "domain_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылочный домен</em><br>ссылка указывает на этот домен"
    },
    "page_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылающаяся страница</em><br>относительный URL страницы, на которой была найдена ссылка"
    },
    "page_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылочная страница</em><br>относительный URL страницы, на которую указывает ссылка"
    },
    "link_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылающаяся страница</em><br>абсолютный URL страницы, на которой была найдена ссылка"
    },
    "link_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ссылочная страница</em><br>абсолютный URL страницы, на которую указывает ссылка"
    },
    "dofollow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>указывает, является ли ссылка dofollow</em><br>если значение — <code>true</code>, у ссылки нет атрибута <code>rel=\"nofollow\"</code>"
    },
    "page_from_scheme": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em><a href=\"https://en.wikipedia.org/wiki/List_of_URI_schemes\" target=\"_blank\" rel=\"noopener noreferrer\">схема URL</a> ссылающейся страницы</em>"
    },
    "page_to_scheme": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em><a href=\"https://en.wikipedia.org/wiki/List_of_URI_schemes\" target=\"_blank\" rel=\"noopener noreferrer\">схема URL</a> ссылочной страницы</em>"
    },
    "direction": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>направление ссылки</em><br>возможные значения: <code>internal</code>, <code>external</code>"
    },
    "is_broken": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>ссылка битая</em><br>указывает, ведёт ли ссылка на битую страницу или ресурс"
    },
    "is_link_relation_conflict": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>указывает, что ссылка может конфликтовать с другой ссылкой</em><br>если <code>true</code>, как минимум одна ссылка, указывающая на <code>link_to</code>, имеет атрибут <code>rel=\"nofollow\"</code> <strong>и</strong> как минимум одна является dofollow"
    },
    "page_to_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код состояния ссылочной страницы</em><br>код состояния страницы, на которую указывает ссылка"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "anchor": "#/components/schemas/Response36Afe1097B20_OnPageAnchorLinkItem",
      "image": "#/components/schemas/Response36Afe1097B20_OnPageImageLinkItem",
      "canonical": "#/components/schemas/Response36Afe1097B20_OnPageCanonicalLinkItem",
      "alternate": "#/components/schemas/Response36Afe1097B20_OnPageAlternateLinkItem",
      "link": "#/components/schemas/Response36Afe1097B20_OnPageLinkLinkItem",
      "redirect": "#/components/schemas/Response36Afe1097B20_OnPageRedirectLinkItem",
      "meta": "#/components/schemas/Response36Afe1097B20_OnPageMetaLinkItem"
    }
  }
}
```

### 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-запросе"
    }
  }
}
```

### Response36Afe1097B20_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "максимальное количество страниц для обхода\nуказывает заданный при постановке задачи лимит max_crawl_pages",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "количество страниц, которые сейчас находятся в очереди на сканирование",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "количество просканированных страниц",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_OnPageLinksResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksResponseInfo`

```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_OnPageLinksTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageLinksResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>статус сеанса сканирования</em><br>возможные значения: <code>in_progress</code>, <code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>сведения о сеансе сканирования</em>"
    },
    "search_after_token": {
      "type": [
        "string",
        "null"
      ]
    },
    "current_offset": {
      "type": [
        "integer",
        "null"
      ]
    },
    "total_items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее количество релевантных элементов в базе данных</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество элементов в массиве результатов</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BaseOnPageLinkItem"
          }
        ]
      },
      "description": "<em>массив элементов</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageLinksTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksTaskInfo`

```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_OnPageLinksResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```