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

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live`

**Tags:** DataForSEO

Поисковый объём, полученный из панелей кликстрима, а не из рекламных платформ, для списка `keywords`. `use_clickstream` переключает смешивание. Возвращает `location_code`, `language_code`, `use_clickstream`, `items_count` и `items`. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Кликстрим-объём часто расходится с `post_dataforseo_keywords_gads_search_volume_live`, в чём и смысл: одно измеряет, что показывают рекламодателям, другое — что делали люди.

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

- Тарификация: заявленная стоимость ответа.
- Справочная оценка запроса: 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>кодировка UTF-8<br>максимальное количество ключевых слов в этом массиве: 1000<br>ключевые слова приводятся к нижнему регистру<p><strong>Примечание:</strong> некоторые символы и знаки (например, UTF-символы, эмодзи) не допускаются<br>чтобы узнать, какие символы можно использовать, см. <a href=\"https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task\" target=\"_blank\" rel=\"noopener noreferrer\">эту статью</a><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\">статье Help Center</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>полное название местоположения поисковой системы</em><br><strong>обязательное поле, если не указан <code>location_code </code></strong><br>список доступных местоположений с <code>location_name</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>пример:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>код местоположения поисковой системы</em><br><strong>обязательное поле, если не указан <code>location_name</code></strong><br>если используете это поле, список доступных местоположений с <code>location_code</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>пример:<br><code class=\"long-string\">2826</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>полное название языка поисковой системы</em><br><strong>обязательное поле, если не указан <code>language_code</code></strong><br>список доступных языков с их <code>language_name</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>пример:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>код языка поисковой системы</em><br><strong>обязательное поле, если не указан <code>language_name</code></strong><br>список доступных языков с их <code>language_code</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>пример:<br><code class=\"long-string\">en</code>"
          },
          "use_clickstream": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>использовать данные clickstream для получения результатов</em><br>необязательное поле<br>если задано <code>true</code>, вы получите значения поискового объёма DataForSEO на основе данных clickstream;<br>если задано <code>false</code>, для расчёта поискового объёма DataForSEO будут использоваться данные поискового объёма Bing;<br>значение по умолчанию: <code>true</code>;<br><strong>Примечание:</strong> поисковый объём Bing доступен для местоположений, указанных в эндпоинтах <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Search Volume History Locations</a> и <a href=\"https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">Bing Ads Locations</a>; значения поискового объёма для любых других местоположений рассчитываются на основе данных clickstream, даже если задать для этого параметра значение <code>false</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "location_code": 2840,
            "language_code": "en",
            "tag": "test-tag",
            "keywords": [
              "you tube",
              "youtube",
              "youtub"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "language_code": "en",
      "tag": "test-tag",
      "keywords": [
        "you tube",
        "youtube",
        "youtub"
      ]
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em><br>если данных нет, значение — <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>языковой код в массиве POST<br></em><br><strong>Примечание:</strong>если ключевое слово в массиве POST выглядит с ошибкой, данные будут возвращены для ключевого слова с правильным написанием;<br>для проверки и валидации написания ключевых слов мы используем функциональность Google Ads API, <a href=\"https://support.google.com/google-ads/answer/7476658\" target=\"_blank\" rel=\"noopener noreferrer\">подробнее по этой ссылке</a>"
    },
    "use_clickstream": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>указывает, активен ли параметр <code>use_clickstream</code></em><br>возможные значения: <code>true</code>, <code>false</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество результатов, возвращённых в массиве <code>items</code></em>"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem"
          }
        ]
      },
      "description": "<em>массив ключевых слов</em><br>содержит ключевые слова и их показатели поискового объёма"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo`

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

### Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem

`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ключевое слово, указанное в массиве POST</em>"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>текущий показатель поискового объёма ключевого слова</em>",
      "format": "int64"
    },
    "monthly_searches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
          }
        ]
      },
      "description": "<em>помесячные показатели поискового объёма</em><br>массив объектов с показателями поискового объёма для определённого месяца года"
    }
  }
}
```

### 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": "среднемесячный показатель поискового объёма"
    }
  }
}
```