# Конкуренты приложений App Store (live)

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/apple/app_competitors/live`

**Tags:** DataForSEO

Приложения App Store, конкурирующие с заданным приложением по общим ключевым словам. Страницы с `limit`, `offset` и `offset_token`; используйте токен после первых страниц. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Аналог для Google Play: `post_dataforseo_labs_google_app_competitors_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": {
          "app_id": {
            "type": "string",
            "description": "<em>идентификатор приложения</em><br><strong>обязательное поле</strong><br>идентификатор мобильного приложения в App Store;<br>идентификатор можно найти в URL каждого приложения, размещённого в App Store;<br>пример:<br>в URL <code>https://apps.apple.com/us/app/id835599320</code><br>идентификатор — <code>835599320</code>"
          },
          "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> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Примечание:</strong> этот эндпоинт сейчас поддерживает только английский язык;<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> можно получить отдельным запросом к <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Примечание:</strong> этот эндпоинт сейчас поддерживает только английский язык<br>пример:<br><code class=\"long-string\">en</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>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>пример:<br><code>[\"intersections\",\"&gt;\",500]</code><p><code>[[\"competitor_metrics.app_store_search_organic.pos_1\",\"&lt;&gt;\",10],\"and\",[\"avg_position\",\"&gt;=\",\"10\"]]</code><p><code>[[[\"intersections\",\"&gt;=\",50],\"and\",[\"competitor_metrics.app_store_search_organic.pos_1\",\"in\",[1,5]]],<br>\"or\",<br>[\"sum_position\",\"&gt;=\",\"10000\"]]</code><p>подробнее о фильтрах — в <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> или в <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">этом руководстве справочного центра</a>"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>правила сортировки результатов</em><br>необязательное поле<br>можно использовать те же значения, что и в массиве <code>filters</code>, для сортировки результатов;<br>возможные типы сортировки:<br><code>asc</code> - результаты сортируются по возрастанию;<br><code>desc</code> - результаты сортируются по убыванию;<br>для задания типа сортировки используйте запятую;<br>пример:<br><code>[\"intersections,asc\"]</code><br><strong>Примечание:</strong> в одном запросе можно задать не более трёх правил сортировки;<br>несколько правил сортировки нужно разделять запятой;<br>пример:<br><code>[\"intersections,desc\",\"sum_position,asc\"]</code><p>правило по умолчанию:<br><code>[\"intersections,desc\"]</code><br><strong>Примечание:</strong> если массив <code>item_types</code> содержит типы элементов, отличные от <code>organic</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": [
          {
            "app_id": "686449807",
            "language_name": "English",
            "location_code": 2840,
            "limit": 10
          }
        ]
      }
    ]
  },
  "example": [
    {
      "app_id": "686449807",
      "language_name": "English",
      "location_code": 2840,
      "limit": 10
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AppMetricsInfo

`#/components/schemas/Response36Afe1097B20_AppMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где товар занимает позицию №1</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где товар занимает позиции №2-3</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где товар занимает позиции №4-10</em>"
    },
    "pos_11_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество органических SERP, где товар занимает позиции №11-100</em>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общее количество органических SERP Amazon, содержащих товар</em>",
      "format": "int64"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>общий объем поиска ключевых слов, по которым товар ранжируется в органическом SERP</em>",
      "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_DataforseoLabsAppleAppCompetitorsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAppleAppCompetitorsLiveResponseInfo`

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

### Response36Afe1097B20_DataforseoLabsAppleAppCompetitorsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAppleAppCompetitorsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "app_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>id приложения в массиве POST</em>"
    },
    "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_DataforseoLabsleAppCompetitorsLiveItem"
          }
        ]
      },
      "description": "<em>содержит данные, связанные с <code>app_id</code> и приложениями-конкурентами</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAppleAppCompetitorsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAppleAppCompetitorsLiveTaskInfo`

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

### Response36Afe1097B20_DataforseoLabsleAppCompetitorsLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsleAppCompetitorsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>тип поисковой системы</em>"
    },
    "app_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>id приложения в массиве POST</em>"
    },
    "avg_position": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>средняя позиция приложения в SERP Google Play</em><br><strong>Примечание:</strong> средняя позиция рассчитывается только по пересекающимся ключевым словам;<br>значение для конкретного приложения может отличаться при сочетании с другими целевыми приложениями",
      "format": "float"
    },
    "sum_position": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>сумма всех позиций приложения в SERP Google Play</em><br><strong>Примечание:</strong> сумма позиций рассчитывается только по пересекающимся ключевым словам;<br>значение для конкретного приложения может отличаться при сочетании с другими целевыми приложениями"
    },
    "intersections": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>количество пересекающихся ключевых слов</em>"
    },
    "competitor_metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_AppMetricsInfo"
      },
      "description": "<em>метрики по пересекающимся ключевым словам</em><br>данные ранжирования по ключевым словам, которые указанное приложение-конкурент разделяет с приложением в запросе POST;<br><strong>примечание:</strong> в этом массиве данные ранжирования приводятся для <code>app_id</code> возвращённого конкурента"
    },
    "full_metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_AppMetricsInfo"
      },
      "description": "<em>метрики по всем ключевым словам приложения</em><br>полный обзор данных ранжирования по всем ключевым словам, для которых ранжируется указанный <code>app_id</code>"
    }
  }
}
```