# Связанные ключевые слова

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live`

**Tags:** DataForSEO

Поисковые запросы Amazon, связанные с исходным ключевым словом. Страницы с `limit`, `offset` и `offset_token`; используйте токен после первых страниц. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Аналог на стороне Google — `post_dataforseo_labs_google_related_keywords_live`; покупательское и веб-намерение сильно расходятся, поэтому не заменяйте одно другим.

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

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.1356.
- Справочный множитель для клиента: 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": {
          "keyword": {
            "type": "string",
            "description": "<em>ключевое слово</em><br><strong>обязательное поле</strong><br>кодировка UTF-8<br>ключевые слова указываются в нижнем регистре<p>подробнее о правилах и ограничениях полей <code>keyword</code> и <code>keywords</code> в API DataForSEO — в <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">этой статье справочного центра</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>полное название местоположения</em><br><strong>обязательное поле, если не указан <code>location_code</code></strong><br><strong>Примечание:</strong> необходимо указать <code>location_name</code> или <code>location_code</code><br>список доступных местоположений с <code>location_name</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Примечание:</strong> этот эндпоинт сейчас поддерживает только местоположения США, Египта, Саудовской Аравии и Объединённых Арабских Эмиратов;<br>пример:<br><code class=\"long-string\">United States</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>код местоположения</em><br><strong>обязательное поле, если не указан <code>location_name</code></strong><br><strong>Примечание:</strong> необходимо указать <code>location_name</code> или <code>location_code</code><br>список доступных местоположений с <code>location_code</code> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Примечание:</strong> этот эндпоинт сейчас поддерживает только местоположения США, Египта, Саудовской Аравии и Объединённых Арабских Эмиратов;<br>пример:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>полное название языка</em><br><strong>обязательное поле, если не указан <code>language_code</code></strong><br><strong>Примечание:</strong> необходимо указать <code>language_name</code> или <code>language_code</code><br>список доступных местоположений с <code>language_name</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>пример:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>код языка</em><br><strong>обязательное поле, если не указан <code>language_name</code></strong><br><strong>Примечание:</strong> необходимо указать <code>language_name</code> или <code>language_code</code><br>список доступных местоположений с <code>language_code</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>пример:<br><code class=\"long-string\">en</code>"
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>глубина поиска по ключевым словам</em><br>необязательное поле<br>значение по умолчанию: <code>1</code>;<br>количество возвращаемых результатов зависит от значения, заданного в этом поле;<br>можно указать уровень от 0 до 4;<br>примерное количество ключевых слов для каждого уровня (максимум):<br>0 - ключевое слово, заданное в поле <code>keyword</code><br>1 – 6 ключевых слов<br>2 – 42 ключевых слова<br>3 – 258 ключевых слов<br>4 – 1554 ключевых слова"
          },
          "include_seed_keyword": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>включить данные для исходного ключевого слова</em><br>необязательное поле<br>если установлено <code>true</code>, данные для исходного ключевого слова, указанного в поле <code>keyword</code>, будут предоставлены в массиве <code>seed_keyword_data</code> ответа<br>значение по умолчанию: <code>false</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>игнорировать очень похожие ключевые слова</em><br>необязательное поле<br>если установлено <code class=\"prettyprint\">true</code>, будут возвращены только основные ключевые слова, все очень похожие ключевые слова будут исключены;  <br>значение по умолчанию: <code>false</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>, первые десять ключевых слов в массиве результатов будут пропущены, а данные будут предоставлены для последующих ключевых слов"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "keyword": "computer mouse",
            "language_name": "English",
            "location_code": 2840,
            "limit": 5,
            "include_seed_keyword": true
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keyword": "computer mouse",
      "language_name": "English",
      "location_code": 2840,
      "limit": 5,
      "include_seed_keyword": true
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AmazonKeywordData

`#/components/schemas/Response36Afe1097B20_AmazonKeywordData`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип поисковой системы"
    },
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "связанное ключевое слово"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код местоположения в массиве POST",
      "format": "int64"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "код языка в массиве POST"
    },
    "keyword_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo"
        }
      ],
      "description": "информация о ключевом слове для возвращенного ключевого слова"
    }
  }
}
```

### Response36Afe1097B20_AmazonKeywordInfo

`#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип поисковой системы"
    },
    "last_updated_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "дата и время обновления данных по ключевому слову\nв формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”\nпример:    '2019-11-15 12:57:46 +00:00'"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "среднемесячный показатель объема поиска\nпредставляет (приблизительное) число поисковых запросов для предложенной идеи ключевого слова на Amazon",
      "format": "int64"
    }
  }
}
```

### 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_DataforseoLabsAmazonRelatedKeywordsLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "keyword_data": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
        }
      ],
      "description": "<em>данные ключевого слова для возвращённого ключевого слова</em>"
    },
    "depth": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>глубина поиска ключевых слов</em>"
    },
    "related_keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "<em>список связанных ключевых слов</em><br>представляет список поисковых запросов, связанных с ключевым словом, возвращённым в массиве выше"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo`

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

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "seed_keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ключевое слово в массиве POST</em>"
    },
    "seed_keyword_data": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
        }
      ],
      "description": "<em>данные ключевого слова для исходного ключевого слова</em><br>поля объекта идентичны полям <code>keyword_data</code>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код языка в массиве POST</em>"
    },
    "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_DataforseoLabsAmazonRelatedKeywordsLiveItem"
          }
        ]
      },
      "description": "<em>содержит объекты с ключевыми словами и связанными данными</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo`

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