# 競合

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/backlinks/competitors/live`

**Tags:** DataForSEO

1 つの `target` と参照ドメインを共有するサイトを、共有数順に並べます。各行には `target`、`rank`、`intersections`（共有リンクドメインの数）が含まれます。`main_domain`、`exclude_large_domains`、`exclude_internal_backlinks` が何を数えるかを決めます。これらはリンクグラフ上の競合であり、検索競合ではありません。後者には `post_dataforseo_labs_google_serp_competitors_live` を使用してください。実際に共有されているドメインを確認するには `post_dataforseo_backlinks_domain_intersection_live` を使用してください。

### 料金の参考情報

- 計量方式：レスポンスで報告されるコスト。
- 参考リクエスト見積もり：0.0276 USD。
- 参考顧客乗数：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": {
          "target": {
            "type": "string",
            "description": "<em>競合ドメインを取得するドメイン、サブドメイン、またはウェブページ</em><br><strong>必須フィールド</strong><br>ドメインまたはサブドメインは <code>https://</code> と <code>www.</code> を付けずに指定します<br>ページは絶対 URL（<code>http://</code> または <code>https://</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> を指定すると、結果配列の最初の 10 件のドメインがスキップされ、後続のページのデータが返されます"
          },
          "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>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br><code>%</code> 演算子を <code>like</code>、<code>not_like</code> と組み合わせて、0 文字以上の任意の文字列に一致させることができます<br>例:<br><code>[\"rank\",\"&gt;\",\"100\"]</code><p><code>[[\"target\",\"like\",\"%forbes%\"],<br>\"and\",<br>[[\"rank\",\"&gt;\",\"100\"],\"or\",[\"intersections\",\"&gt;\",\"5\"]]]</code><p>使用可能なフィルターの完全な一覧は<a href=\"/v3/backlinks/filters/?bash\" 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>[\"rank,desc\"]</code><br><strong>1 回のリクエストで設定できる並び替えルールは 3 つまでです</strong><br>複数の並び替えルールはカンマで区切ります<br>例:<br><code>[\"intersections,desc\",\"rank,asc\"]</code>"
          },
          "main_domain": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>検索に <code>target</code> のメインドメインのみを含めるかどうかを示します</em><br>任意フィールド<br><code>true</code> に設定すると、メインドメインのみが検索に含まれます<br>デフォルト値: <code>true</code>"
          },
          "exclude_large_domains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>大手ドメインを結果に含めるかどうかを示します</em><br>任意フィールド<br><code>true</code> に設定すると、大手ドメイン（google.com、amazon.com など）からの結果は除外されます<br>デフォルト値: <code>true</code>"
          },
          "exclude_internal_backlinks": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>サブドメインから <code>target</code> への内部被リンクを結果から除外するかどうかを示します</em><br>任意フィールド<br><code>true</code> に設定すると、<code>target</code> と同じドメインのサブドメインからの内部被リンクのデータは結果に含まれません<br><code>false</code> に設定すると、内部リンクが結果に含まれます<br>デフォルト値: <code>true</code>"
          },
          "rank_scale": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em><code>rank</code>、<code>domain_from_rank</code>、<code>page_from_rank</code> の値を計算・表示する際のスケールを定義します</em><br>任意フィールド<p>このパラメータを使用して、rank 値を 0〜100 と 0〜1000 のどちらのスケールで表示するかを選択できます<p>指定可能な値:<br><code>one_hundred</code> — rank 値は 0〜100 のスケールで表示されます<br><code>one_thousand</code> — rank 値は 0〜1000 のスケールで表示されます<p>デフォルト値: <code>one_thousand</code><p>このパラメータの動作とランキング指標の計算方法については、<a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">こちらのヘルプセンターの記事</a>をご覧ください"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ユーザー定義のタスク識別子</em><br>任意フィールド<br><em>文字数上限は 255 です</em><br>このパラメーターを使ってタスクを識別し、結果と照合できます<br>指定した <code>tag</code> の値は、レスポンスの <code>data</code> オブジェクトに含まれます"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "filters": [
              "rank",
              ">",
              100
            ],
            "order_by": [
              "rank,desc"
            ],
            "limit": 5
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "filters": [
        "rank",
        ">",
        100
      ],
      "order_by": [
        "rank,desc"
      ],
      "limit": 5
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。

**application/json**

Schema: object | null

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

### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。

### 401 — 有効な Felo API キーが必要です。

### 402 — 請求要件が満たされていないため、リクエストを続行できません。

### 403 — このアカウントにはこの操作を行う権限がありません。

### 429 — リクエストまたは支出の上限に達しました。

### 502 — サービスがリクエストを完了できませんでした。

### 503 — API または請求サービスが一時的に利用できません。

### 504 — リクエストの処理中にサービスがタイムアウトしました。

### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksCompetitorsLiveItem

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "要素の種類"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>競合ドメイン</em>"
    },
    "rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインランク</em><br>データベース内のすべてのドメインを対象としたドメインランク<br><code>rank</code> は、リンクデータベースにおけるノードランキングの手法に基づいて計算されます。これは元の Google PageRank アルゴリズムで採用された原則です<br>この指標と計算方法の詳細については、こちらの<a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api\" rel=\"noopener noreferrer\" target=\"_blank\">ヘルプセンター記事</a>を参照してください"
    },
    "intersections": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 配列で指定された <code>target</code> との被リンク交差数を示します</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResponseInfo`

```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_BacklinksCompetitorsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>タスクの配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "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_BacklinksCompetitorsLiveItem"
          }
        ]
      },
      "description": "<em>項目の配列</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksCompetitorsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_BacklinksCompetitorsLiveTaskInfo`

```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_BacklinksCompetitorsLiveResultInfo"
              }
            ]
          },
          "description": "<em>結果の配列</em>"
        }
      }
    }
  ]
}
```

### 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": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 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 リクエストで指定したものと同じパラメーターを含みます"
    }
  }
}
```