# Настройка live-задач «Поисковый объём»

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/bing/search_volume/live`

**Tags:** DataForSEO

Поисковый объём Bing для списка `keywords`. Возвращает `keyword`, `location_code`, `language_code`, `search_partners`, `device`, `competition`, `cpc`, `search_volume`, `categories` и `monthly_searches` — обратите внимание на `categories`, которых нет в эквиваленте для Google, и на отсутствие `competition_index`. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Двойник для Google — `post_dataforseo_keywords_gads_search_volume_live`; запускайте оба, когда аудитория не только в Google. Парные эндпоинты submit и fetch выполняют ту же работу асинхронно и по той же цене — для пакетов, которые слишком велики, чтобы дожидаться их завершения.

### Справочная информация о ценах

- Тарификация: заявленная стоимость ответа.
- Справочная оценка запроса: USD 0.09.
- Справочный множитель для клиента: 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": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>ключевые слова</em><br><strong>обязательное поле</strong><br>максимальное количество ключевых слов: 1000<br>максимальное количество символов в каждом ключевом слове: 100<br>указанные ключевые слова приводятся к нижнему регистру, данные предоставляются в отдельном массиве. Подробнее о правилах и ограничениях полей <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\" target=\"_blank\" rel=\"noopener noreferrer\">статье Help Center</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>полное название местоположения поисковой системы</em><br><strong>обязательное поле, если не указаны</strong> <code>location_code</code> или <code>location_coordinate</code><br><strong>если используете это поле, <code>location_code</code> или <code>location_coordinate</code> указывать не нужно</strong><br>список доступных местоположений поисковой системы с их <code>location_name</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>пример:<br><code class=\"long-string\">London,England,United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>код местоположения поисковой системы</em><br><strong>обязательное поле, если не указаны</strong> <code>location_name</code> или <code>location_coordinate</code><br><strong>если используете это поле, <code>location_name</code> или <code>location_coordinate</code> указывать не нужно</strong><br>список доступных местоположений поисковых систем с их <code>location_code</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>пример:<br><code class=\"long-string\">2840</code>"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<em>GPS-координаты местоположения</em><br><strong>обязательное поле, если не указаны</strong> <code>location_name</code> или <code>location_code</code><br><strong>если используете это поле, <code>location_name</code> или <code>location_code</code> указывать не нужно</strong><br>параметр <code>location_coordinate</code> указывается в формате <em>\"широта,долгота\"</em><br><strong>данные будут предоставлены для страны, к которой относятся указанные координаты</strong><br>пример:<br><code class=\"long-string\">52.6178549,-155.352142</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>полное название языка поисковой системы</em><br><strong>обязательное поле, если не указан</strong> <code>language_code</code><br>если используете это поле, <code>language_code</code> указывать не нужно<br>поддерживаемые языки:<br><code>English</code>, <code>French</code>, <code>German</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>код языка поисковой системы</em><br><strong>обязательное поле, если не указан</strong> <code>language_name</code><br>если используете это поле, <code>language_name</code> указывать не нужно<br>поддерживаемые языки:<br><code class=\"long-string\">en</code>, <code>fr</code>, <code>de</code>"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>тип устройства</em><br>необязательное поле<br>укажите это поле, чтобы получить данные для определённого типа устройства;<br>возможные значения: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>значение по умолчанию: <code>all</code>"
          },
          "sort_by": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>параметры сортировки результатов</em><br>необязательное поле<br>Используйте эти параметры для сортировки результатов по <code>search_volume</code>, <code>cpc</code>, <code>competition</code> или <code>relevance</code> по убыванию<br>значение по умолчанию: <code>relevance</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>начальная дата временного диапазона</em><br>необязательное поле<br>минимальное значение: 24 месяца от сегодняшней даты;<br>если не указать это поле, данные будут предоставлены за последние 12 месяцев;<br>минимальное значение: два года назад от сегодняшней даты;<br>если <a href=\"/v3/keywords_data/bing/status/\" target=\"_blank\" rel=\"noopener noreferrer\">эндпоинт Status</a> возвращает <code>false</code> в поле <code>actual_data</code>, <code>date_from</code> можно установить на позапрошлый месяц и ранее;<br>если <a href=\"/v3/keywords_data/bing/status/\" target=\"_blank\" rel=\"noopener noreferrer\">эндпоинт Status</a> возвращает <code>true</code> в поле <code>actual_data</code>, <code>date_from</code> можно установить на прошлый месяц и ранее;<br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2020-01-01\"</code><strong>Примечание:</strong> мы не рекомендуем задавать собственный временной диапазон для дат прошлого года"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>конечная дата временного диапазона</em><br>необязательное поле<br>если не указать это поле, данные будут предоставлены за последние 12 месяцев;<br>минимальное значение: два года назад от сегодняшней даты;<br>максимальное значение: один месяц от сегодняшней даты;<br><strong>примечание:</strong> мы не рекомендуем задавать собственный временной диапазон для дат прошлого года;<br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2020-03-15\"</code><strong>Примечание:</strong> мы не рекомендуем задавать собственный временной диапазон для дат прошлого года"
          },
          "search_partners": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>тип партнёров поиска Bing</em><br>необязательное поле<br>если указать <code class=\"prettyprint\">true</code>, результаты будут предоставлены для собственных, управляемых и синдицированных сетей Bing, Yahoo, AOL и партнёрских сайтов, размещающих поиск Bing, AOL и Yahoo.<br>значение по умолчанию: <code>false</code> — результаты возвращаются для поисковых сетей Bing, AOL и Yahoo"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "location_name": "United States",
            "language_code": "en",
            "keywords": [
              "tom and jerry",
              "silicon valley",
              "spider man"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_name": "United States",
      "language_code": "en",
      "keywords": [
        "tom and jerry",
        "silicon valley",
        "spider man"
      ]
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

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

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ключевое слово в массиве POST</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em><br>если данных нет, значение — <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код языка в массиве POST</em><br>если данных нет, значение — <code>null</code>"
    },
    "search_partners": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>указывает, включены ли в ответ данные партнёрских сетей</em>"
    },
    "device": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип устройства в массиве POST</em><br>если данных нет, значение —_<code>null</code>n"
    },
    "competition": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>конкуренция</em><br>относительный уровень конкуренции по указанному ключевому слову только в платной выдаче SERP. Значение основано на данных Bing Ads.<br>Возможные значения: <code>0.1</code>, <code>0.5</code>,<code>0.9</code><code>0.1</code> — низкая конкуренция,<br><code>0.5</code> — средняя конкуренция,<br><code>0.9</code> — высокая конкуренция;<br>если данных нет, значение — <code>null</code>"
    },
    "cpc": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>цена за клик</em><br>средняя цена за клик (USD), исторически уплаченная за ключевое слово.<br>если данных нет, значение —_<code>null</code>n"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>среднемесячный показатель поискового объёма<br></em>приблизительное количество поисковых запросов по указанной идее ключевого слова в поисковой системе Bing с учётом таргетинга пользователя;<br>поисковый объём округляется до ближайших десятков;<br>если данных нет, значение —_<code>null</code>n",
      "format": "int64"
    },
    "categories": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>категории товаров и услуг</em><br>наш API не возвращает категории для этого эндпоинта: параметр всегда равен <code>null</code>"
    },
    "monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
          }
        ]
      },
      "description": "<em>поисковых запросов в месяц</em><br>приблизительное количество поисковых запросов по этой идее ключевого слова (за последние двенадцать месяцев), нацеленных на указанные географические локации<br>если данных нет, значение —_<code>null</code>n"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingSearchVolumeLiveTaskInfo`

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

### Response36Afe1097B20_MonthlySearchesInfo

`#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo`

```json
{
  "type": "object",
  "properties": {
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "год"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "месяц"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "среднемесячный показатель поискового объёма"
    }
  }
}
```