検査の実行
リクエスト フォーマット
POST /audit/createリクエスト パラメータ
| 名称 | 必須 | 説明 |
| domain | はい | 検査対象ウェブサイト 例: seranking.com |
| title | いいえ | 検査の名称 最大300文字まで。標準ではdomainの値がタイトルになります |
| group_id | いいえ | 検査グループID 標準では 0 (general)に設定されます |
| settings | いいえ | 検査設定 変更が必要なパラメータのみが追加される（その値はデフォルト値と異なっていなければならない）。 |
検査設定。全てのパラメータは任意項目です。
| 名称 | 説明 | 使用可能な値 | 標準値 |
| schedule_type | スキャン頻度 | manual week month | manual |
| schedule_day | 検査実施日 | 1-31 | 1 |
| schedule_hour | 検査開始時間 | 0-23 | 0 |
| schedule_wdays | 検査を実施する曜日 ( 1 から 7)。 | [1,2,3,4,5,6,7] | [] |
| send_report | 検査結果を含むレポート送信 (1 – 送信する, 0 – 送信しない) | 1,0 | 1 |
| report_emails | レポート送信先のEメールリスト | “” | 標準ではレポートはアカウントEメールに送信される |
| source_site | サイトの全てのページをクロールするか否か (メインページから開始して内部リンクを辿る)。 (0) が設定されていれば、サイトマップや提出済みのリストページだけがクロールされます。 | 1,0 | 1 |
| source_sitemap | サイトマップをソースとしてクロール (sitemap.xml) | 1,0 | 1 |
| source_subdomain | ウェブサイトのサブドメインをクロールする。(0) を設定しなかった場合は、サブドメインへのリンクは外部リンクとみなされます。 | 1,0 | 0 |
| source_file | カスタムページリストを使用 | 1,0 | 0 |
| check_robots | robots.txtファイルの現在の指示リストに基づいてサイトをクロール | 1,0 | 1 |
| ignore_params | URLパラメータを無視 | 0(無視しない), 1(全て), 2(カスタム) | 0 |
| custom_params | 無視するパラメータのリスト。ignore_params=2 を使用した場合。 | utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID | |
| ignore_noindex | noindex を無視 | 0,1 | 0 |
| ignore_nofollow | nofollow を無視 | 0,1 | 0 |
| user_agent | User-Agent ヘッダの値 (サイト検査で利用可能な14のオプション) | 0-13 | 0 (seranking bot) |
| login | ベーシック HTTP 認証用ログイン | ||
| password | ベーシック HTTP 認証用パスワード | ||
| max_pages | スキャン対象の最大ページ数 | 1-300000 | 1000 |
| max_depth | 最大スキャン深度（階層） | 1-100 | 10 |
| max_req | 1秒あたりの最大リクエスト数 | 1-500 | 500 |
| max_redirects | 最大リダイレクト数 | 1-50 | 5 |
| min_title_len | 最小のtitleの長さ | 1-10000 | 20 |
| max_title_len | 最大のtitleの長さ | 1-10000 | 65 |
| min_description_len | 最小のmeta descriptionの長さ | 1-10000 | 1 |
| max_description_len | 最大のmeta descriptionの長さ | 1-10000 | 158 |
| max_size | 最大ページサイズ（キロバイト） | 1-100000 | 3000 |
| min_words | ページあたりの最少単語数 | 1-10000 | 250 |
| max_h1_len | H1見出しの最大の長さ | 1-10000 | 100 |
| max_h2_len | H2見出しの最大の長さ | 1-10000 | 100 |
| allow | 指定の値で始まるURLのページのみチェックを許可 | ||
| disallow | 指定の値で始まるURLのページのチェックを許可しない | ||
| hide | 指定の値で始まるURLやリソースを隠す |
結果
成功すると、サーバーは検査IDを返します。
例
{
“id”: 100000222
}検査のリスタート
リクエスト フォーマット
POST /audit/{report_id}/recheck結果
成功すると、サーバーは 200 HTTP コードを返します。
検査リスト
リクエスト フォーマット
POST /audit/listリクエスト パラメータ
| 名前 | 説明 |
| limit | リスト内の項目数 |
| offset | オフセット値 |
| group_id | 検査グループID。標準では 0 (general) に設定されています |
| only_with_project | 1件のプロジェクトの検査のみ |
| search | titleやウェブサイトURLで絞り込み検索。 |
| date_start | 検査開始日で絞り込み検索。 |
| date_end | 検査終了日で絞り込み検索。 |
結果
例
{
“items”: [
{
“id”: 6193559,
“url”: “http://seranking.com”,
“title”: “seranking.com”,
“has_project”: true,
“last_update”: “2023-06-16”,
“status”: “finished”,
“stats”: {
“score”: 66,
“errors”: 73,
“warnings”: 448,
“notices”: 389,
“crawled”: 100
},
“prev_stats”: {
“score”: 76,
“errors”: 72,
“warnings”: 447,
“notices”: 387,
“crawled”: 100
}
},
…
]
“total”: 810
}検査の名称変更
リクエスト フォーマット
POST /audit/{report_id}/editリクエスト パラメータ
| 名前 | 説明 |
| title | 新しい検査名。最大 300 文字。 |
結果
成功すると、サーバーは 200 HTTP コードを返します。
検索の削除
リクエスト フォーマット
POST /audit/{report_id}/delete結果
成功すると、サーバーは 200 HTTP コードを返します。
検査ステータス
リクエスト フォーマット
GET /audit/{report_id}または
GET /audit/?id={id}結果
成功すると、サーバーは検査ステータスを返します。
例
{
“status”: “finished”,
“start_time”: “2018-06-15 12:41:13”,
“audit_time”: “2018-09-11 16:13:41”,
“total_pages”: 10,
“total_warnings”: 71,
“total_errors”: 21,
“total_passed”: 810
}レスポンス パラメータ
| 名前 | 説明 |
| status | canceled – 検査がキャンセルされています; expired – 検査が完了してから3ヶ月以上経過して、検査が無効な状態です; queued – 検査は現在キュー待ちです; processing – 検査を実施中です; finished – 検査は完了しています |
| start_time | 検査開始時刻 |
| audit_time | 検査終了時刻 |
| total_pages | スキャンされたページ数合計 |
| total_warnings | 注意数の合計 |
| total_errors | 重要なエラーの合計数 |
| total_passed | チェック合格の合計数 |
検査レポート
検査が完了した場合のみデータをご利用いただけます (“is_finished”: true)。
リクエスト フォーマット
GET /audit/{report_id}/report結果
“is_finished”: true – 検査レポートで利用可能なデータ。
“is_finished”: false – 検査が完了した場合。
例
{
“is_finished”: false
}{
“is_finished”: true,
“domain_props”: {
“archiveOrg”: “2003-02-26”,
“backlinks”: “4”,
…
},
“sections”: [
{
“uid”: “tech_audit”,
“name”: “Название раздела”,
“props”: [
{
“code”: “_images_500_count”,
“status”: “passed”,
“name”: “Изображений с ответом 5хх”,
“value”: “0”
},
…],
…
],
“score_percent”: 79,
“total_pages”: 10,
“total_warnings”: 71,
“total_errors”: 21,
“total_passed”: 810,
“audit_time”: “2018-09-11 16:13:41”
}レスポンス パラメータ
| 名前 | 説明 |
| is_finished | 検査ステータス |
| domain_props | ドメイン情報 (全体のドメイン設定リストを含む) |
| score_percent | 健全性スコア (%) |
| audit_time | 検査終了時刻 |
| total_pages | スキャン済みページ合計数 |
| total_notices | 通知の合計数 |
| total_warnings | 注意の合計数 |
| total_errors | 重要なエラーの合計数 |
| total_passed | チェック合格の合計数 |
| sections | 検査セクション |
| uid | セクションID |
| name | セクション名 |
| props | セクションチェックのリスト |
| 名称 | 説明 |
| expdate | ドメイン更新期限 |
| ip | ドメイン IP アドレス |
| backlinks | 被リンク数 |
| index_google | Googleのインデックスページ数 |
| index_bing | Bingのインデックスページ数 |
| index_yahoo | Yahooのインデックスページ数 |
| 名称 | 説明 |
| status | ステータス (warning | error | passed) |
| code | チェックコード |
| value | チェックの値 |
ページリスト
指定チェック用のページリストです。
リクエスト フォーマット
GET /audit/{report_id}/links?code={code}&limit=100&offset=10リクエスト パラメータ
| 名称 | 必須 | 説明 |
| code | はい | チェックコード。詳細は GET /audit/{report_id}/report を参照 |
| limit | いいえ | 合計リンク数。リンクの最大数 – 1000 |
| offset | いいえ | オフセット値 |
結果
成功すると、サーバーは指定した検査用のページリストを返します。
例
次の場合 urls_type: urls_and_sources
{
“total_urls”: 10,
“urls”: [
{
“id”: 1248462,
“url”: “https://seranking.com/”
},
…
],
“urls_type”: “urls_and_sources”
}次の場合 urls_type: simple_urls_array
{
“total_urls”: 10,
“urls”: [
“https://seranking.com/keyword-suggestion-tool.html”,
…
],
“urls_type”: “simple_urls_array”
}次の場合 urls_type: duplicate_props
{
“total_urls”: 2,
“urls”: {
“Online SEO Tools by SE Ranking”: {
“found_on_urls”: [
{
“url”: “https://seranking.com/position-tracking.html”,
“id”: “1248466”,
“cnt”: “10”
},
…
],
}
,
“urls_type”: “duplicate_props”
}レスポンス パラメータ
| 名称 | 説明 |
| total_urls | URLの合計数 |
| urls | URLのリスト。リストの形式はチェックの種類によって異なります |
| urls_type | リストの種類: simple_urls_array duplicate_props urls_and_single_source urls_and_sources |
エラー
| HTTP コード | エラーメッセージ |
| 400 | Invalid code |
検査履歴
リクエスト フォーマット
GET /audit/{report_id}/history?date=2018-06-01リクエスト パラメータ
| 名称 | 必須 | 説明 |
| date | はい | 検査の日付 |
例
{
“audit_time”: “2023-05-29 00:19:41”,
“domain_data”: {
“dt”: 88,
“domain”: “seranking.com”,
“domains”: “15135”,
“expdate”: “2024-09-16”,
“updated”: “2023-05-29 00:01:03”,
“backlinks”: “810981”,
“index_bing”: 545828,
“all_checked”: true,
“index_yahoo”: 400372,
“index_google”: “131473”
},
“settings”: {
“schedule_type”: “week”,
“schedule_day”: 1,
“schedule_hour”: 0,
“schedule_wday”: 1,
“schedule_wdays”: [
“1”
],
“schedule_repeat”: 0,
“schedule_repeat_interval”: 2,
“send_report”: 1,
“report_email”: “”,
“report_emails”: “”,
“source_site”: 1,
“source_sitemap”: 1,
“source_subdomain”: 0,
“source_file”: 0,
“check_robots”: 1,
“ignore_params”: 0,
“custom_params”: “utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID”,
“user_agent”: 0,
“login”: “”,
“password”: “”,
“max_pages”: 500,
“max_depth”: 10,
“max_req”: 500,
“min_title_len”: 20,
“max_title_len”: 65,
“min_description_len”: 1,
“max_description_len”: 158,
“max_size”: 3000,
“min_words”: 250,
“max_redirects”: 5,
“disable_audit”: 0,
“disabled_issues”: [],
“ignore_noindex”: 0,
“ignore_nofollow”: 0,
“max_h1_len”: 100,
“max_h2_len”: 100,
“allow”: “”,
“disallow”: “”,
“hide”: “”
},
“pages_data”: {
“css_big”: 343,
“h1_long”: 1,
“http4xx”: 2,
“js_many”: 48,
“links3xx”: 308,
“image_big”: 2,
“h2_missing”: 29,
“html_ratio”: 263,
“title_long”: 30,
“amp_missing”: 1,
“css_not_min”: 1,
“extlinks3xx”: 424,
“extlinks4xx”: 10,
“less_inlink”: 1,
“redirect3xx”: 13,
“title_short”: 11,
“h1_duplicate”: 31,
“image_no_alt”: 426,
“same_title_h1”: 1,
“links_nofollow”: 335,
“low_word_count”: 11,
“hreflang_return”: 50,
“links_no_anchor”: 415,
“title_duplicate”: 2,
“description_long”: 110,
“extlinks_nofollow”: 424,
“hreflang_xdefault”: 391,
“blocked_by_noindex”: 59,
“extlinks_no_anchor”: 60,
“redirect_temporary”: 5,
“blocked_by_nofollow”: 3,
“description_duplicate”: 2
},
“totals”: {
“total_pages”: 500,
“total_warnings”: 1917,
“total_errors”: 59,
“total_passed”: 102
}
}レスポンス パラメータ
| 名称 | 説明 |
| audit_time | 検査終了時刻 |
| domain_data | ドメインとサイト全体に関連するパラメータ |
| settings | 設定 (サイト設定が別れて設定されている場合は、このパラメータは欠落していることもあります) |
| pages_data | ページチェックパラメータ |
| totals | 詳しくは、 GET /audit/{report_id}/report を参照 |