# OnPage API サマリー **API:** Data API **Endpoint:** `GET /v1/beta/dataforseo/on_page/summary/{id}` **Tags:** DataForSEO 1 回のクロールの状態と概要指標を `id` で取得します。`crawl_progress`、`crawl_status`、`crawl_gateway_address`、`crawl_stop_reason`、`domain_info`、`page_metrics` を返します。DataForSEO のエンベロープに包まれます。データは `tasks[0].result`、結果は `tasks[0].status_code` に格納され、拒否されたリクエストでも HTTP 200 が返ります。**クロールが完了したかを知る方法もこれです**——ここにある他のエンドポイントを読む前に、`crawl_progress` が `finished` になるまでポーリングしてください。そうしないと、本物に見える部分的な結果を読むことになります。💰 アップストリームは無料：完了したクロールの照会には費用がかからず、費用がかかるのはクロール自体だけです。 ### 料金の参考情報 - 計測方法：報告されたレスポンスコスト。 - 参考リクエスト見積もり：0.012 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`) ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | `id` | path | yes | string | タスク識別子
必須フィールド
この ID は、Task POST エンドポイントのレスポンスで取得できます
例：
“07131248-1535-0216-1000-17384017ad04” | ## Responses ### 200 — 操作成功 Headers: - `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。 **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo" } ] } ``` ### 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_CrawlStatusInfo `#/components/schemas/Response36Afe1097B20_CrawlStatusInfo` ```json { "type": "object", "properties": { "max_crawl_pages": { "type": [ "integer", "null" ], "description": "クロールするページ数の上限\n タスク設定時に指定した max_crawl_pages の制限を示します", "format": "int64" }, "pages_in_queue": { "type": [ "integer", "null" ], "description": "現在クロールキューにあるページ数", "format": "int64" }, "pages_crawled": { "type": [ "integer", "null" ], "description": "クロール済みのページ数", "format": "int64" } } } ``` ### Response36Afe1097B20_DomainInfo `#/components/schemas/Response36Afe1097B20_DomainInfo` ```json { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "description": "ドメイン名" }, "cms": { "type": [ "string", "null" ], "description": "コンテンツ管理システム
ウェブサイトで識別されたコンテンツ管理システム
generator メタタグの内容
データは 200 レスポンスコードを返す最初のランダムなページから取得されます
当社のクローラーが CMS を識別できなかった場合、値は null になります" }, "ip": { "type": [ "string", "null" ], "description": "ドメインの IP アドレス" }, "server": { "type": [ "string", "null" ], "description": "ウェブサイトサーバー
ウェブサイトで検出されたサーバーのバージョン
server ヘッダーの内容
情報はレスポンスコードが 200 の最初のページから取得されます" }, "crawl_start": { "type": [ "string", "null" ], "description": "クロール開始時刻
ウェブサイトがクロールのために送信された日時
UTC 形式: “yyyy-mm-dd hh-mm-ss +00:00”
例:
2019-11-15 12:57:46 +00:00" }, "crawl_end": { "type": [ "string", "null" ], "description": "クロール終了時刻
クロールが完了した日時
UTC 形式: “yyyy-mm-dd hh-mm-ss +00:00”
例:
2019-11-15 12:57:46 +00:00
注意: \"crawl_progress\" が \"finished\" の場合にのみ有効な情報です
\"crawl_progress\" が in_progress の場合、値は null になります" }, "extended_crawl_status": { "type": [ "string", "null" ], "description": "クロールステータスとエラー
ウェブサイトがクロールされなかった理由を示します
次の値を取ることができます:
no_errors: クロールエラーは検出されませんでした
site_unreachable: 当社のクローラーがウェブサイトに到達できず、ステータスコードを取得できませんでした
invalid_page_status_code: 最初にクロールされたページのステータスコードが 400 以上です
forbidden_meta_tag: 最初にクロールされたページに <meta robots=\"noindex\"> タグが含まれています
forbidden_robots: robots.txt がページのクロールを禁止しています
forbidden_http_header: ページの HTTP ヘッダーに \"X-Robots-Tag: noindex\" が含まれています
too_many_redirects: 最初にクロールされたページのリダイレクトが 10 回を超えています
unknown: 理由は不明です" }, "ssl_info": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_SslInfo" } ], "description": "SSL 証明書情報
ウェブサイトで検出された Secure Sockets Layer プロトコルに関する情報" }, "checks": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "boolean", "null" ] }, "description": "ウェブサイトチェック
ウェブサイトに関連するその他のページ内チェック" }, "total_pages": { "type": [ "integer", "null" ], "description": "クロール済みページの合計
クロールされたページの合計数", "format": "int64" }, "total_uncrawlable_resources": { "type": [ "integer", "null" ], "description": "クロールできないリソースの合計
クロールできなかったリソースの合計数
リソースの実際のコンテンツタイプがクローラーの想定するコンテンツタイプと一致しない場合、そのリソースはクロール不可と見なされます", "format": "int64" }, "page_not_found_status_code": { "type": [ "integer", "null" ], "description": "存在しないページが返すステータスコード
多くの場合、サーバーは 404 レスポンスコードを返すことを推奨します" }, "canonicalization_status_code": { "type": [ "integer", "null" ], "description": "正規化されたページが返すステータスコード
当社のクローラーが IP 経由でウェブサイトにアクセスしようとしたときのサーバー動作の検査
多くの場合、正規化されたページは 301 または 302 ステータスコードを返すことを推奨します" }, "directory_browsing_status_code": { "type": [ "integer", "null" ], "description": "ディレクトリが返すステータスコード
ターゲットウェブサイト上のディレクトリページが返すステータスコード
多くの場合、ディレクトリは 403 または 401 ステータスコードを返すことを推奨します" }, "www_redirect_status_code": { "type": [ "integer", "null" ], "description": "リダイレクトのステータスコード
www から non-www へのリダイレクトのステータスコード
多くの場合、リダイレクトは 301 ステータスコードを返すことを推奨します" }, "main_domain": { "type": [ "string", "null" ], "description": "ルートドメイン名" } } } ``` ### Response36Afe1097B20_OnPageSummaryResponseInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo` ```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_OnPageSummaryTaskInfo" } ] }, "description": "タスクの配列" } } } ] } ``` ### Response36Afe1097B20_OnPageSummaryResultInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryResultInfo` ```json { "type": "object", "properties": { "crawl_progress": { "type": [ "string", "null" ], "description": "クロールセッションのステータス
可能な値：in_progress、finished" }, "crawl_status": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo" } ], "description": "クロールセッションの詳細" }, "crawl_gateway_address": { "type": [ "string", "null" ], "description": "クローラーの IP アドレス
現在のクロールセッションを開始するためにクローラーが使用した IP アドレスを表示します
クローラーが使用する IP の完全なリストは、概要セクションで確認できます" }, "crawl_stop_reason": { "type": [ "string", "null" ], "description": "クロールが停止した理由
クロール処理が停止した理由に関する情報。
可能な値：
limit_exceeded - max_crawl_pages で設定された上限を超えました。
empty_queue - キュー内のすべての URL がクロールされました。
force_stopped - On Page API Force Stop 機能を使用してクロール処理を停止しました。
unexpected_exception - target のクロール中に内部エラーが発生しました。詳細についてはサポートにお問い合わせください" }, "domain_info": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainInfo" } ], "description": "ドメイン全体の情報
対象ドメインとクロール処理に関するページ上の情報" }, "page_metrics": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_PageMetrics" } ], "description": "ページ固有の情報
対象ウェブサイトのページに関する指標情報" } } } ``` ### Response36Afe1097B20_OnPageSummaryTaskInfo `#/components/schemas/Response36Afe1097B20_OnPageSummaryTaskInfo` ```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_OnPageSummaryResultInfo" } ] }, "description": "結果の配列" } } } ] } ``` ### Response36Afe1097B20_PageMetrics `#/components/schemas/Response36Afe1097B20_PageMetrics` ```json { "type": "object", "properties": { "links_external": { "type": [ "integer", "null" ], "description": "外部リンク数
他のウェブサイトを指すリンク数" }, "links_internal": { "type": [ "integer", "null" ], "description": "内部リンク数
対象ウェブサイト内の他のページを指すリンク数" }, "duplicate_title": { "type": [ "integer", "null" ], "description": "タイトルが重複しているページ数" }, "duplicate_description": { "type": [ "integer", "null" ], "description": "説明が重複しているページ数" }, "duplicate_content": { "type": [ "integer", "null" ], "description": "コンテンツが重複しているページ数" }, "broken_links": { "type": [ "integer", "null" ], "description": "壊れたリンク数
対象ウェブサイトのすべてのクロール済みページにおける壊れたリンク数" }, "broken_resources": { "type": [ "integer", "null" ], "description": "壊れたリソース数
リンクが壊れている画像やその他のリソースの数" }, "links_relation_conflict": { "type": [ "integer", "null" ], "description": "対象ウェブサイト上で競合する可能性があるリンク数
たとえば、\"links_relation_conflict\": 2 の場合、対象ウェブサイトは rel=\"nofollow\" 属性を持つ少なくとも 1 つの内部リンクと少なくとも 1 つの dofollow リンクで同じソースを参照しています" }, "redirect_loop": { "type": [ "integer", "null" ], "description": "開始 URL と終了 URL が同じリダイレクトチェーン数
転送先 URL が元の URL にリダイレクトして戻るリダイレクトチェーンの数" }, "onpage_score": { "type": [ "number", "null" ], "description": "100 点満点でウェブサイトの最適化状況を示します
このフィールドは、検出された重大なページ上の問題と警告を考慮したウェブサイトの最適化状況を示します。
100 が可能な最高スコアで、ウェブサイトに重大なページ上の問題や重要な警告がないことを意味します。
注：この値はクロールされたページ数によって異なります。
この指標の計算方法の詳細については、このヘルプセンターの記事をご覧ください" }, "non_indexable": { "type": [ "integer", "null" ], "description": "インデックスできないページ数
robots.txt、HTTP ヘッダー、または meta タグの設定により、Google やその他の検索エンジンによるインデックスがブロックされているページ数。
このエンドポイントを使用すると、インデックスできない URL のリストを取得できます" }, "checks": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "integer", "null" ], "format": "int64" }, "description": "ページ固有のページ上チェック" } } } ``` ### Response36Afe1097B20_SslInfo `#/components/schemas/Response36Afe1097B20_SslInfo` ```json { "type": "object", "properties": { "valid_certificate": { "type": [ "boolean", "null" ], "description": "SSL 証明書の有効性
Web サイトで検出された SSL 証明書が失効、停止、取り消し、無効のいずれでもないかどうかを示します" }, "certificate_issuer": { "type": [ "string", "null" ], "description": "SSL 証明書の発行機関
検出された SSL 証明書を発行したエンティティ" }, "certificate_subject": { "type": [ "string", "null" ], "description": "SSL 証明書のサブジェクト
公開鍵に関連付けられたエンティティ" }, "certificate_version": { "type": [ "integer", "null" ], "description": "SSL 証明書のバージョン
SSL 証明書が使用する X.509 のバージョンを示します" }, "certificate_hash": { "type": [ "string", "null" ], "description": "SSL 証明書のハッシュ
SSL 証明書のハッシュ関数のバージョン" }, "certificate_expiration_date": { "type": [ "string", "null" ], "description": "SSL 証明書の有効期限
SSL 証明書が失効する日時
UTC 形式：“yyyy-mm-dd hh-mm-ss +00:00”
例：
2019-11-15 12:57:46 +00:00" } } } ```