# 被リンク時系列サマリー

**API:** Data API

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

**Tags:** DataForSEO

1 つの `target` の主要な被リンク指標の推移を、`group_range`（日、週、月）でグループ化して返します。`date_from`、`date_to`、`group_range` と各期間の項目を返します。合計ではなく増減が必要な場合は `post_dataforseo_backlinks_timeseries_new_lost_live` を使用してください。このエンドポイントは limit パラメータを受け付けないため、呼び出し頻度を下げることだけが調整手段です。

### 料金の参考情報

- 計量方式：レスポンスで報告されるコスト。
- 参考リクエスト見積もり：0.0273 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>例:<br><code>\"forbes.com\"</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の開始日</em><br>任意フィールド<br>このフィールドは、サマリーデータを判定するしきい値として使用する日付を示します<p>最小値: <code>2019-01-30</code><br>最大値は <code>date_to</code> で指定した日付を超えることはできません<br>日付形式: <code>\"yyyy-mm-dd\"</code><br>例:<br><code>\"2021-01-01\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>期間の終了日</em><br>任意フィールド<br>このフィールドを指定しない場合、今日の日付がデフォルトで使用されます<br>最小値は <code>date_from</code> で指定した日付より前にはできません<br>最大値: 今日の日付<br>日付形式: <code>\"yyyy-mm-dd\"</code><br>例:<br><code>\"2021-01-15\"</code>"
          },
          "group_range": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>結果のグループ化に使用する期間</em><br>任意フィールド<br>デフォルト値: <code>month</code><br>指定可能な値: <code>day</code>、<code>week</code>、<code>month</code>、<code>year</code><p><strong>注意:</strong> <code>day</code> の場合、<code>date_from</code> と <code>date_to</code> の間（両端を含む）のすべての日付に対応する項目を返します<br><code>week</code>/<code>month</code>/<code>year</code> の場合、完全な週/月/年に対応する項目を返し、各項目はその週/月/年の最終日を示します<p>たとえば、次のように指定すると:<br><code>\"group_range\": \"month\",<br>\"date_from\": \"2022-03-23\",<br>\"date_to\": \"2022-05-13\"</code><br>2022-03-01 から 2022-05-31 までの項目、つまり <code>2022-03-31</code>、<code>2022-04-30</code>、<code>2022-05-31</code> の 3 つの日付に対応する項目を返します<p>特定の <code>day</code>/<code>week</code>/<code>month</code>/<code>year</code> のデータがない場合は <code>0</code> を返します"
          },
          "include_subdomains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em><code>target</code> のサブドメインを検索に含めるかどうかを示します</em><br>任意フィールド<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",
            "date_from": "2021-12-01",
            "date_to": "2022-02-01",
            "group_range": "month"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "date_from": "2021-12-01",
      "date_to": "2022-02-01",
      "group_range": "month"
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveItem

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "要素の種類"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ターゲットのデータが保存された日時</em><br>UTC 形式：\"yyyy-mm-dd hh-mm-ss +00:00\"<br>例:<br><code>2019-11-15 12:57:46 +00:00</code>"
    },
    "rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の <code>target</code> ランク</em><br>この指標と計算方法の詳細については、こちらの<a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api\" rel=\"noopener noreferrer\" target=\"_blank\">ヘルプセンター記事</a>を参照してください"
    },
    "backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の被リンク数</em>",
      "format": "int64"
    },
    "backlinks_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の nofollow 被リンク数</em>",
      "format": "int64"
    },
    "referring_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> に <code>target</code> を指すページ数</em>",
      "format": "int64"
    },
    "referring_pages_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> に <code>target</code> へ少なくとも 1 つの nofollow リンクを指している参照ページ数</em>",
      "format": "int64"
    },
    "referring_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の参照ドメイン数</em><br>この指標では、参照ドメインに別個のドメインとしてカウントされるサブドメインが含まれます",
      "format": "int64"
    },
    "referring_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> に <code>target</code> へ少なくとも 1 つの nofollow リンクを指しているドメイン数</em>",
      "format": "int64"
    },
    "referring_main_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の参照メインドメイン数</em>",
      "format": "int64"
    },
    "referring_main_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> に <code>target</code> へ少なくとも 1 つの nofollow リンクを指しているメインドメイン数</em>",
      "format": "int64"
    },
    "referring_ips": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の参照 IP アドレス数</em><br>このページを指す IP アドレスの数",
      "format": "int64"
    },
    "referring_subnets": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>指定された <code>date</code> の参照サブネットワーク数</em>",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResponseInfo`

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

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResultInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列の <code>target</code></em>"
    },
    "date_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>期間の開始日</em><br>UTC 形式：“yyyy-mm-dd”<br>例:<br><code>2019-01-01</code>"
    },
    "date_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>期間の終了日</em><br>UTC 形式：<code>\"yyyy-mm-dd\"</code><br>例:<br><code>\"2019-01-15\"</code>"
    },
    "group_range": {
      "type": [
        "string",
        "null"
      ],
      "description": "POST 配列の group_range"
    },
    "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_BacklinksTimeseriesSummaryLiveItem"
          }
        ]
      },
      "description": "<em>関連するサマリーデータを含みます</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksTimeseriesSummaryLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_BacklinksTimeseriesSummaryLiveTaskInfo`

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