# 過去のランク概要

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live`

**Tags:** DataForSEO

ドメインのランク概要を、利用可能な履歴の各時点の状態で示します。このエンドポイントは limit パラメータを受け付けませんが、項目単位ではなく呼び出し単位で課金されるため、リスト全体を一度に送信してください。DataForSEO のエンベロープに包まれます。データは `tasks[0].result`、結果は `tasks[0].status_code` に格納され、拒否されたリクエストでも HTTP 200 が返ります。まず `get_dataforseo_labs_google_available_history` を確認してください。存在する日付が示されており、その範囲外の日付を要求するとエラーではなく何も返りません。現在のスナップショットは `post_dataforseo_labs_google_domain_rank_overview_live` です。

### 料金の参考情報

- 計量方式：レスポンスで報告されるコスト。
- 参考リクエスト見積もり：0.1356 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>ターゲットウェブサイトのドメイン名<br>ドメインは <code>https://</code> と <code>www.</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>例：<br><code class=\"long-string\">United Kingdom</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>例：<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>例：<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>例：<br><code class=\"long-string\">en</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の開始日</em><br>任意フィールド<br>このフィールドを指定しない場合、過去 6 か月分のデータが提供されます<br>指定可能な最小値：<code>2020-10-01</code><br>日付形式：<code>\"yyyy-mm-dd\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の終了日</em><br>任意フィールド<br>このフィールドを指定しない場合、デフォルトで今日の日付が使用されます<br>日付形式：<code>\"yyyy-mm-dd\"</code><br>例：<br><code>\"2021-04-01\"</code>"
          },
          "correlate": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>データを以前に取得したデータセットと関連付ける</em><br>任意フィールド<br>デフォルト値：<code>true</code><br>このパラメーターを使用すると、今回取得するデータが以前に取得したデータセットと関連付けられます<br>このパラメーターは、データベースの変更によって生じる可能性のある不整合を軽減するためのものです<br><code>correlate</code> は常に <code>true</code> に設定することをお勧めします"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>類似性の高いキーワードを無視</em><br>任意フィールド<br><code class=\"prettyprint\">true</code> に設定すると、コアキーワードに基づくデータのみが返され、類似性の高いキーワードのデータはすべて除外されます；  <br>デフォルト値：<code>false</code>"
          },
          "include_clickstream_data": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>結果にクリックストリームベースの指標データを含めるか除外する</em><br>任意フィールド<br>パラメーターを <code>true</code> に設定すると、レスポンスにクリックストリームデータを含む <code>clickstream_etv</code>、<code>clickstream_gender_distribution</code>、<code>clickstream_age_distribution</code> フィールドが含まれます；<br>デフォルト値：<code>false</code>；<p><strong>注意：</strong>過去のクリックストリームデータは 2024/05（2024 年 5 月）以降利用できます；<br><strong>このパラメーターを有効にすると、リクエスト料金は 2 倍になります；</strong><br>クリックストリームベースの指標の計算方法については、こちらの <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">ヘルプセンター記事</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",
            "location_code": 2840,
            "language_code": "en",
            "date_from": "2021-01-01",
            "date_to": "2021-03-29"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "location_code": 2840,
      "language_code": "en",
      "date_from": "2021-01-01",
      "date_to": "2021-03-29"
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**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": "タスクのステータスコード\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 リクエストで指定したものと同じパラメーターを含みます"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>検索エンジンの種類</em>"
    },
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>データが提供される年</em>"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>データが提供される月</em>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo"
      },
      "description": "<em>指定したドメインに関連するランキングデータ</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo`

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

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>検索エンジンの種類</em>"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>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_DataforseoLabsGoogleHistoricalRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>過去のランキングとトラフィックのデータを含みます</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo`

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

### Response36Afe1097B20_DataforseoLabsMetricsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo`

```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_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 11〜20 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 21〜30 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 31〜40 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 41〜50 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 51〜60 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 61〜70 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 71〜80 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 81〜90 位にランクインしているオーガニック SERP の数</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインが 91〜100 位にランクインしているオーガニック SERP の数</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>推定トラフィック量</em><br>ドメインまたはサブドメインへの推定オーガニック月間トラフィック<br>ドメインまたはサブドメインがカテゴリ内でランクインしているすべてのキーワードの CTR（クリック率）と検索ボリュームの積で算出されます<br>指標の計算方法の詳細については、<a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">このヘルプセンター記事</a>をご覧ください"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ドメインまたはサブドメインを含むオーガニック SERP の総数</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>オーガニック検索トラフィックを有料に転換する推定コスト</em><br>ドメインまたはサブドメインがカテゴリ内でランクインしているすべてのキーワードの推定月間広告コスト（USD）を表します<br>この指標は、オーガニックの <code>etv</code> と有料の <code>cpc</code> の値の積として算出され、Google 検索での PPC 広告を通じて推定月間オーガニックトラフィックを獲得するためのコストを示します<br>指標の計算方法の詳細については、<a href=\"https://dataforseo.com/help-center/how-is-traffic-cost-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">このヘルプセンター記事</a>をご覧ください"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>新規ランクイン要素の数</em><br>指定したターゲットで新たに見つかったランクイン要素の数を示します"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>順位の上昇</em><br>指定したターゲットのランクイン要素がどれだけ上昇したかを示します"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>順位の低下</em><br>指定したターゲットのランクイン要素がどれだけ低下したかを示します"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>失われたランクイン要素</em><br>指定したターゲットのランクイン要素のうち、以前は SERP に表示されていたが前回のチェックで見つからなかったものを示します"
    },
    "clickstream_etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>クリックストリームデータに基づく推定トラフィック量</em><br>ドメインがランクインしているすべてのキーワードのクリック率（CTR）とクリックストリーム検索ボリューム値の積として算出されます<br>このフィールドの結果を取得するには、パラメーター <code>include_clickstream_data</code> を <code>true</code> に設定する必要があります<br>指標の計算方法の詳細については、<a href=\"https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">このヘルプセンター記事</a>をご覧ください",
      "format": "double"
    },
    "clickstream_gender_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>性別別の推定クリックストリームベース指標の分布</em><br>このフィールドの結果を取得するには、パラメーター <code>include_clickstream_data</code> を <code>true</code> に設定する必要があります<br>指標の計算方法の詳細については、<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">このヘルプセンター記事</a>をご覧ください"
    },
    "clickstream_age_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>年齢別のクリックストリームベース指標の分布</em><br>このフィールドの結果を取得するには、パラメーター <code>include_clickstream_data</code> を <code>true</code> に設定する必要があります<br>指標の計算方法の詳細については、<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">このヘルプセンター記事</a>をご覧ください"
    }
  }
}
```