# Настройка live-задач «DataForSEO Trends Subregion Interests»

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/dataforseo_trends/subregion_interests/live`

**Tags:** DataForSEO

Где сосредоточен интерес к ключевому слову, в разбивке по субрегионам внутри `location_code`. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Если нужны люди, а не места, используйте `post_dataforseo_keywords_trends_demography_live`.

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

- Тарификация: заявленная стоимость ответа.
- Справочная оценка запроса: USD 0.0024.
- Справочный множитель для клиента: 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>максимальное количество ключевых слов: 5<br>избегайте символов и специальных знаков (например, UTF-символов, эмодзи);<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\">статье Help Center</a>"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>полное название местоположения поисковой системы</em><br>необязательное поле<br>если не использовать это поле, вы получите глобальные результаты<br><strong>если используете это поле, <code>location_code</code> указывать не нужно</strong><br>список доступных местоположений поисковой системы с их <code>location_name</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>данные будут предоставлены для страны, к которой относится указанный <code>location_name</code>;</strong><br>пример:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>код местоположения поисковой системы</em><br>необязательное поле<br>если не использовать это поле, вы получите глобальные результаты<br><strong>если используете это поле, <code>location_name</code> указывать не нужно</strong><br>список доступных местоположений поисковых систем с их <code>location_code</code> можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>данные будут предоставлены для страны, к которой относится указанный <code>location_code</code>;</strong><br>пример:<br><code class=\"long-string\">2840</code>"
          },
          "type": {
            "type": [
              "string",
              "null"
            ],
            "description": "тип элемента"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>начальная дата временного диапазона</em><br>необязательное поле<br>если не указать это поле, по умолчанию будут использованы текущий день и месяц предыдущего года<br>минимальное значение для типа <code>web</code>: <code>2004-01-01</code><br>минимальное значение для других типов: <code>2008-01-01</code><br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2019-01-15\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>конечная дата временного диапазона</em><br>необязательное поле<br>если не указать это поле, по умолчанию будет использована сегодняшняя дата<br>формат даты: <code>\"yyyy-mm-dd\"</code><br>пример:<br><code>\"2019-01-15\"</code>"
          },
          "time_range": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>предустановленные временные диапазоны</em><br>необязательное поле<br>если указать параметры <code>date_from</code> или <code>date_to</code>, это поле будет проигнорировано при постановке задачи<br><em>возможные значения для всех параметров <code>type</code>:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "keywords": [
              "rugby",
              "cricket"
            ],
            "date_from": "2023-01-01",
            "date_to": "2024-01-01",
            "type": "web",
            "location_name": "United States"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keywords": [
        "rugby",
        "cricket"
      ],
      "date_from": "2023-01-01",
      "date_to": "2024-01-01",
      "type": "web",
      "location_name": "United States"
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AbsoluteItems

`#/components/schemas/Response36Afe1097B20_AbsoluteItems`

```json
{
  "type": "object",
  "properties": {
    "geo_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>идентификатор местоположения</em><br>это поле позволяет сопоставить полученные результаты с параметрами местоположения, указанными в запросе<br>полный список доступных местоположений с их <code>geo_id</code> смотрите <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">здесь</a> или получите отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>пример:<br><code>US-NY</code>"
    },
    "geo_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>название местоположения</em><br>это поле позволяет сопоставить полученные результаты с параметрами местоположения, указанными в запросе<br>полный список доступных местоположений с их <code>geo_name</code> смотрите <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">здесь</a> или получите отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>пример:<br><code>Andorra</code>"
    },
    "values": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>содержит данные об относительной популярности ключевых слов по странам или регионам</em>"
    }
  }
}
```

### Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem

`#/components/schemas/Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "position": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>выравнивание элемента</em><br>может принимать следующие значения: <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code> и т. д."
    },
    "keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>ключевые слова в массиве POST</em>"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "dataforseo_trends_graph": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsDataforseoTrendsGraphElementItem",
      "subregion_interests": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem",
      "demography": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsDemographyElementItem"
    }
  }
}
```

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

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseKeywordDataDataforseoTrendsItem"
    },
    {
      "type": "object",
      "properties": {
        "interests": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsInfo"
              }
            ]
          },
          "description": "<em>данные о популярности ключевых слов в субрегионах для каждого указанного термина</em>"
        },
        "interests_comparison": {
          "type": [
            "object",
            "null"
          ],
          "oneOf": [
            {
              "$ref": "#/components/schemas/Response36Afe1097B20_InterestsComparison"
            }
          ],
          "description": "<em>сравнение данных о популярности ключевых слов в субрегионах для указанных параметров</em><br>если вы указали одно ключевое слово, значение будет <code>null</code>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoTrendsinterestsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>соответствующее ключевое слово</em><br>данные в элементе <code>values</code> основаны на этом ключевом слове"
    },
    "values": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo"
          }
        ]
      },
      "description": "<em>содержит данные об относительной популярности ключевых слов по странам или регионам</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo

`#/components/schemas/Response36Afe1097B20_DataforseoTrendsinterestsValuesInfo`

```json
{
  "type": "object",
  "properties": {
    "geo_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>идентификатор местоположения</em><br>это поле позволяет сопоставить полученные результаты с параметрами местоположения, указанными в запросе<br>полный список доступных местоположений с их <code>geo_id</code> смотрите <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">здесь</a> или получите отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>пример:<br><code>US-NY</code>"
    },
    "geo_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>название местоположения</em><br>это поле позволяет сопоставить полученные результаты с параметрами местоположения, указанными в запросе<br>полный список доступных местоположений с их <code>geo_name</code> смотрите <a href=\"/v3/keywords_data/dataforseo_trends/locations/\" rel=\"noopener noreferrer\" target=\"_blank\">здесь</a> или получите отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>пример:<br><code>Andorra</code>"
    },
    "value": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>относительный показатель популярности ключевого слова в заданной локации</em><br>представляет показатель популярности ключевого слова с учётом локации за указанный временной диапазон;<br>с помощью этого <code>value</code> можно понять, насколько ключевое слово популярно в одной локации по сравнению с другой;<br>расчёт: мы определяем наибольшее значение популярности соответствующего ключевого слова по всем локациям, а затем выражаем все остальные значения как процент от этого наибольшего значения (100);<br>значение <code>100</code> — наибольшая популярность термина<br>значение <code>50</code> означает, что термин вдвое менее популярен<br>значение <code>0</code> означает, что данных по этому термину недостаточно"
    }
  }
}
```

### Response36Afe1097B20_InterestsComparison

`#/components/schemas/Response36Afe1097B20_InterestsComparison`

```json
{
  "type": "object",
  "properties": {
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AbsoluteItems"
          }
        ]
      },
      "description": "<em>содержит популярность ключевого слова и связанные данные</em>"
    },
    "absolute_items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AbsoluteItems"
          }
        ]
      },
      "description": "<em>показатели популярности ключевых слов по всем местоположениям</em><br>значения в этом массиве представляют проценты относительно максимального значения по всем местоположениям"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo`

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

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keywords": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>ключевые слова в массиве POST</em>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "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>"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>дата и время получения результата</em><br>в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”<br>пример:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество результатов, возвращённых в массиве <strong><code>items</code></strong></em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoTrendsSubregionInterestsElementItem"
          }
        ]
      },
      "description": "<em>содержит популярность ключевого слова и связанные данные</em>"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo`

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