# App Store 应用竞争对手（实时）

**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`。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：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>应用 ID</em><br><strong>必填字段</strong><br>App Store 上移动应用的 ID；<br>可在 App Store 中每个应用的 URL 中找到该 ID；<br>示例：<br>在 URL <code>https://apps.apple.com/us/app/id835599320</code> 中<br>ID 为 <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>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_name</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>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_code</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>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_name</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>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用语言及其 <code>language_code</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>data</code> 对象中找到指定的 <code>tag</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 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AppMetricsInfo

`#/components/schemas/Response36Afe1097B20_AppMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>商品排名 #1 的自然 SERP 数量</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>商品排名 #2-3 的自然 SERP 数量</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>商品排名 #4-10 的自然 SERP 数量</em>"
    },
    "pos_11_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>商品排名 #11-100 的自然 SERP 数量</em>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>包含该商品的 Amazon 自然 SERP 总数</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": "任务总费用，美元",
      "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": "任务总费用，美元",
      "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>POST 数组中的应用 ID</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>POST 数组中的应用 ID</em>"
    },
    "avg_position": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>应用在 Google Play SERP 中的平均位置</em><br><strong>注意：</strong>平均位置仅针对交集关键词计算；<br>给定应用与不同目标应用组合时，该值可能不同",
      "format": "float"
    },
    "sum_position": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>应用在 Google Play SERP 中所有位置之和</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> 所排名的全部关键词相关的排名数据完整概览"
    }
  }
}
```