プロジェクト/サイト 管理

Project Management API はプロジェクトを管理(作成・編集・削除)する事ができ、プロジェクトやキーワード別の統計を取得する事ができます。

ユーザーのサイトリスト

このメソッドは、ユーザーの全てのプロジェクトのリストを取得する事ができます。

リクエスト フォーマット

GET https://api4.seranking.com/sites

レスポンス例

成功すると、サーバーは 200 HTTP コードを返します。

[
{
“id”: 1,
“title”: “zniqpf tfallp mykqeg”,
“name”: “Cronin.info”,
“group_id”: 0,
“is_active”: 1,
“exact_url”: 0,
“subdomain_match”: 0,
“depth”: 100,
“check_freq”: “check_daily”,
“check_day”: null,
“guest_link”: “https://seranking.com/guest.html?site_id=1&hv=0&hash=432&tab=detailed”
}
]
名称 説明
id ユニークサイトID
title ウェブサイト名
name ウェブサイトURL
group_id ウェブサイトグループID
is_active ウェブサイトステータス 1 – active, 0 – delayed
exact_url 1 – サブドメインとサブフォルダを除いた特定のURLの順位のみをチェックします
subdomain_match 1 – SERP上でサブドメインも考慮する
depth 順位収集の深度(範囲)
check_freq チェック頻度
check_day 週毎のチェック頻度(check_weekly)の場合、このパラメータは曜日が示されます。 (1 – 月曜日 から 7 –日曜日) 月毎のチェック頻度(check_monthly)の場合、このパラメータは日付が示されます。 (1 – 31)
guest_link サイトの統計を認証無しで閲覧可能なゲストリンク

サイトの検索エンジンリスト

このメソッドはプロジェクトで指定されている検索エンジンリストを取得する事ができます。

リクエスト フォーマット

GET https://api4.seranking.com/sites/{site_id}/search-engines

結果

成功すると、サーバーは200HTTPコードとプロジェクトの検索エンジンリストを返します。

レスポンス例

[
{
«site_engine_id»: 1,
«search_engine_id»: 339,
«region_id»: 0,
«region_name»: null,
«lang_code»: «ru»,
«merge_map»: 0,
«business_name»: null,
«phone»: null,
«paid_results»: 0,
«featured_snippet»: 0
}
]

パラメータ:

名称 説明
search_engine_id 検索エンジン ID (GET /system/search-engines を参照)
region_id Region ID。Yandexのみ (GET /system/yandex-regions を参照)
region_name リージョン。Googleのみ対応 (次を参照 GET /system/google-regions)
lang_code 言語コード (/system/google-langs を参照)
merge_map Googleマップ検索結果を考慮する。 0 – 考慮しない, 1 –考慮する, 2 – 考慮して個別に表示する
business_name Googleマップ検索結果のビジネス名
phone Googleマップ検索結果の会社電話番号
paid_results Google 広告の順位追跡 (1 – はい, 0 – いいえ)
featured_snippet 強調スニペットを考慮する (1 – 考慮する, 0 –考慮しない)

エラー

HTTP コード エラーメッセージ/th>
400 Invalid keyword_id
400 Invalid date
400 No ids in request
404 Unknown search_engine_id
404 Unknown site_engine_id

プロジェクトへの検索エンジン追加

このメソッドは、プロジェクトに検索エンジンを新たに追加する事ができます。

リクエスト フォーマット

POST https://api4.seranking.com/sites/{site_id}/search-engines

{
“search_engine_id”: 339,
“region_id”: 0,
“region_name”: null,
“lang_code”: “ru”,
“merge_map”: 0,
“business_name”: null,
“phone”: null,
“paid_results”: 0,
“featured_snippet”: 0
}

パラメータ:

名称 必須 説明
search_engine_id はい 検索エンジン ID (GET /system/search-engines を参照)
region_id いいえ Region ID。Yandexのみ (GET /system/yandex-regions を参照)
region_name いいえ 英語の地域名 (region / city)。Googleのみ
lang_code いいえ 言語コード (/system/google-langs を参照)
merge_map いいえ Googleマップ検索結果を考慮する。 0 – 考慮しない, 1 –考慮する, 2 – 考慮して個別に表示する
business_name いいえ Googleマップ検索結果のビジネス名
phone いいえ Googleマップ検索結果の会社電話番号
paid_results いいえ Google 広告の順位追跡 (1 – はい, 0 – いいえ)
featured_snippet いいえ 強調スニペットを考慮する (1 – 考慮する, 0 –考慮しない)

結果

成功すると、サーバーは201 HTTPコードと、追加された検索エンジンの site_engine_id を返します。

エラー

HTTP コード エラーメッセージ
404 Unknown search_engine_id

プロジェクトの検索エンジン変更

このメソッドは、プロジェクトに検索エンジンを新たに追加する事ができます。

リクエスト フォーマット

PUT https://api4.seranking.com/sites/{site_id}/search-engines/{site_engine_id}
{
“region_id”: 0,
“region_name”: null,
“lang_code”: “ru”,
“merge_map”: 0,
“business_name”: null,
“phone”: null,
“paid_results”: 0,
“featured_snippet”: 0
}

Parameters

パラメータ – プロジェクトへの検索エンジン追加を参照してください。

結果

成功するとサーバーは200 HTTPコードを返します。

プロジェクトの検索エンジン削除

リクエスト フォーマット

DELETE https://api4.seranking.com/sites/{site_id}/search-engines/{site_engine_id}

結果

成功すると、サーバーは204 HTTPコードを返します。

ウェブサイトのキーワードリスト

このメソッドは、特定のプロジェクトのターゲットページに関するキーワードリストを取得する事ができます。

リクエスト フォーマット

GET https://api4.seranking.com/sites/{site_id}/keywords?site_engine_id=NNN

リクエスト パラメータ

名称説明
search_engine_id任意のパラメータ。
Search engine ID (GET /system/search-engines 参照)
成功すると、first_check_date を返します。


結果

I成功すると、サーバーはプロジェクトのキーワード配列とそれらの統計を返します。

名称 説明
id ユニーククエリ ID
name キーワード
group_id クエリグループ ID
link ターゲット URL
first_check_date 最初にクエリをチェックした日付

レスポンス例

[
{
“id”: “1”,
“name”: “key1”,
“group_id”: “2”,
“link”: null,
“first_check_date”: “2015-02-17”,
“tags”: [
“11”,
“12”
]
},
{
“id”: “2”,
“name”: “key2”,
“group_id”: “2”,
“link”: “http://mysite.com/”,
“first_check_date”: null,
“tags”: []
},

]

統計のサマリ

このメソッドはプロジェクトの統計のサマリを取得する事ができます。

リクエスト フォーマット

GET https://api4.seranking.com/sites/{site_id}/stat

結果

名称 説明
site_id ユニークウェブサイト ID
today_avg 最新の順位チェック日(今日)の平均順位
yesterday_avg 前回の順位チェック日(昨日)の平均順位
total_up 順位上昇の合計数
total_down 順位下降の合計数
process ウェブサイト順位の現時点での処理度合(パーセント)
top5 TOP 5以内のキーワード
top10 TOP 10以内のキーワード
top30 TOP 30以内のキーワード
visibility トラフィック予測値
visibility_percent ヴィジビリティ(%表示)
index_yandex Yandexのインデックス数
yandex_x Yandex X
index_google Googleのインデックス数

レスポンス例

{
“site_id”: 123,
“name”: “site1.com”,
“group_id”: null,
“title”: “my site”,
“today_avg”: 123,
“yesterday_avg”: 111,
“total_up”: 0,
“total_down”: 5,
“process”: “99.9”,
“top5” : 1,
“top10” : 2,
“top30” : 3,
“visibility” : 2,
“visibility_percent” : 30.0,
“da” : 4,
“index_yandex” : 100,
“index_google” : 200,
“index_x” : null,
}

キーワードの統計

このメソッドは、指定期間内のプロジェクトのキーワード順位チェックの統計を取得する事ができます。

リクエスト フォーマット

GET https://api4.seranking.com/sites/{site_id}/positions?date_from=2018-01-01&date_to=2018-01-07&site_engine_id=1&with_landing_pages=1&with_serp_features=1

パラメータ

クエリのパラメータです。全てのパラメータは任意です。

名称 形式 説明
date_from yyyy-mm-dd 期間の開始日 (デフォルトでは今日から一週間前)
date_to yyyy-mm-dd 期間の終了日 (デフォルトでは今日)
site_engine_id 検索エンジン ID。指定されていなければ、全ての検索エンジンのデータが返されます。
in_top 順位で絞込。例えば、in_top=10 は指定した期間で最後にチェックされたTOP 10以内のキーワードのみが返されます。
with_landing_pages 検索結果のページのURL情報
with_serp_features キーワード検索結果で検知されたGoogle SERPの特徴。

結果

成功すると、サーバーは指定した期間内のキーワード統計を含めてプロジェクトの全ての(または指定された)検索エンジンの配列を返します。

名称 説明
id ユニーククエリ ID
positions 要素の配列
date 日付
change 前回の日付と比較した順位の差 (マイナスもあり得ます)
pos 現在の順位
is_map 順位が掲載された場所を示します; 0 値は自然検索結果, 1 は地図ブロック
map_position “オーガニックとマップ検索結果を別々に集計”オプションが利用可(merge_map = 2)の状態における地図ブロックの順位
paid_position Google検索結果の広告順位
landing_pages 要素の配列 date – yyyy-mm-dd 形式の日付 url – キーワードごとの検索結果のページURL
features 要素の配列。値が true なら、プロジェクトのウェブサイトのリンクを含みます
volume 検索ボリューム
competition 競合性
suggested_bid CPC(Cost per click)
kei KEI(Keyword Efficiency Index)
results 指定キーワードのGoogle検索結果数
total_sum 成果報酬レポート設定で算出されるキーワードごとの費用/td>

レスポンス例

[
{
“site_engine_id”: 1,
“keywords”: [
{
“id”: “12”,
“positions”: [
{
“date”: “2017-12-19”,
“pos”: 18,
“change”: 0,
“price”: 0,
“is_map”: 0,
“map_position”: 0,
“paid_position”: 0
}
],
“volume”: 390,
“competition”: 3,
“suggested_bid”: 1,
“kei”: 1,
“resultsi”: 100,
“total_sum”: 0,
“landing_pages”: [
{
“url”: “https://domain.com/page.html”,
“date”: “2017-12-14”
}
],
“features”: {
“tads”: true,
“knowledge_graph”: true,
“images”: true,
“sitelinks”: true,
“reviews”: false
},
},

]

エラー

HTTP コード エラーメッセージ
404 Invalid site_engine_id

広告の合計数

このメソッドは、日別の上部・下部広告の合計数のデータを取得します。

リクエスト フォーマット

 GET https://api4.seranking.com/sites/{site_id}/ads?date_from=2020-05-20&date_to=2020-05-21&site_engine_ids[]=1&site_engine_ids[]=2&keywords_ids[]=1&keywords_ids[]=1 

パラメータ

クエリパラメータです。全てのパラメータは任意で選択できます。

名称タイプ説明
date_fromyyyy-mm-dd期間指定の開始日 (標準では今日から1週間前の日)
date_toyyyy-mm-dd期間指定の終了日 (標準では今日)
site_engine_ids検索エンジン ID フィルタ用です。
指定されていない場合は、全ての検索エンジンのデータが返されます。
keywords_idsキーワード ID フィルタ用です.
指定されていない場合は、全てのキーワードのデータが返されます。

結果

成功すると、サーバーは該当するプロジェクトの全ての(または指定した)検索エンジンからのデータの配列を返します。この配列には指定した期間の日別の全ての(または指定した)キーワードに関する検索結果の上・下広告の数のデータを含みます。

最大で100,000 件の結果を返します。該当するプロジェクトでキーワード数が多すぎる場合には、検索エンジンやキーワードのIDや期間を指定してデータを絞り込む事をおすすめします。

名称説明
site_engine_id検索エンジンID
keywordsキーワードと広告数のデータ配列
idキーワード ID
ads日別の広告数のデータ配列
date日付
tabs上部広告の合計数
bads下部広告の合計数

レスポンス例


[{
“site_engine_id”: 1,
“keywords”: [
{
“id”: 1,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 2,
“bads”: 3
},
{
“date”: “2020-05-21”,
“tads”: 3,
“bads”: 2
},
]
},
{
“id”: 2,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 0,
“bads”: 0
},
{
“date”: “2020-05-21”,
“tads”: 0,
“bads”: 1
},
]
},
]
},
{
“site_engine_id”: 2,
“keywords”: [
{
“id”: 1,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 1,
“bads”: 1
},
{
“date”: “2020-05-21”,
“tads”: 2,
“bads”: 2
},
]
},
{
“id”: 2,
“ads”: [
{
“date”: “2020-05-20”,
“tads”: 0,
“bads”: 2
},
{
“date”: “2020-05-21”,
“tads”: 5,
“bads”: 1
},
]
},
]
}]

プロジェクトへのクエリ追加

このメソッドは、プロジェクトに新しいキーワードを追加する事ができます。

リクエスト フォーマット

POST https://api4.seranking.com/api/sites/{site_id}/keywords
[{
“keyword”:”text”,
“group_id”:1,
“target_url”: “http://site.com/”,
“is_strict”: 0,
“comment”:”text”
}]

リクエスト パラメータ

名称 必須 説明
keyword はい キーワード (クエリ)
group_id いいえ キーワードグループ ID (パラメータが指定されていなければ、デフォルトグループが使用されます)
target_url いいえ ターゲットリンク/td>
is_strict いいえ 指定したターゲットリンクのみの順位をチェック (0 または 1; 0 がデフォルト)
comment いいえ コメント

結果

成功すると、サーバーは追加されたキーワードの配列と、プロジェクト IDを返します。

名称 必須 説明
added はい プロジェクトに追加されたクエリの数
ids いいえ 追加されたクエリのIDの配列

レスポンス例

{
“added”: 3,
“ids”: [
123,
456,
789
]
}

エラー

HTTP コード エラーメッセージ
400 No keywords specified

プロジェクトのキーワード変更

このメソッドは、プロジェクト内のキーワード設定を変更する事ができます。

リクエスト フォーマット

PATCH https://api4.seranking.com/api/sites/{site_id}/keywords/{keyword_id}

{
“keyword”:”text”,
“target_url”: “http://site.com/”,
“comment”:”text”
}

リクエスト パラメータ

名称 説明
keyword キーワード (検索クエリ)
group_id 別のプロジェクトキーワードグループにキーワードを移行する際のキーワードグループID (プロジェクトキーワードグループ IDのリストからの値を使用します)
target_url 対象リンク
is_strict 特定の対象リンクのみの順位をチェック (0 または 1 で 0 はデフォルトオプション)
comment コメントテキスト

結果

成功すると、サーバーは200 HTTPコードを返します。

エラー

HTTP コード エラーメッセージ
400 Invalid or empty keyword data
403 Access denied (wrong site_id)
404 Unknown keyword (wrong keyword_id)

プロジェクトの追加

このメソッドはユーザーアカウントに新しいプロジェクトを追加する事ができます。

リクエスト フォーマット

POST https://api4.seranking.com/sites
[{
“utl”:”http://test.site/”,
“title”:”seo site”
}]

リクエスト フォーマット

名称 必須 説明
url はい ウェブサイト URL
title はい プロジェクト名
depth いいえ 順位収集の深度 (100, 200), 100がデフォルト
subdomain_match いいえ 検索結果のサブドメインも考慮する? (0 または 1), 0 がデフォルト
exact_url いいえ 完全一致 URL? (0 または 1), 0 がデフォルト
check_freq いいえ 順位チェック頻度 (‘check_daily’,’check_1in3′,’check_weekly’, ‘check_monthly’, ‘manual’), check_daily がデフォルト
auto_reports いいえ 週次レポート? (0 または 1), 1 がデフォルト
site_group_id いいえ 新規追加されたプロジェクトのグループ ID
check_day いいえ 週毎のチェック頻度(check_weekly)の場合、このパラメータは曜日が示されます。 (1 – 月曜日 から 7 –日曜日) 月毎のチェック頻度(check_monthly)の場合、このパラメータは日付が示されます。 (1 – 31)
is_active いいえ プロジェクトステータス 1 – active, 0 – delayed

結果

成功すると、サーバーは 201 HTTP コードとアカウントに追加されたプロジェクトの ID を返します。

名称 必須 説明
site_id はい アカウントに追加されたプロジェクトのID

レスポンス例

{
“site_id”: 507052
}

プロジェクト設定の変更

このメソッドはプロジェクト設定の変更/更新を行う事ができます。

リクエスト フォーマット

PUT https://api4.seranking.com/sites/{site_id}
{
“title”:”new site title”
}

リクエスト パラメータ

名称 説明
url ウェブサイト URL
title プロジェクト名
depth 順位収集の深度 (100, 200), 100がデフォルト
subdomain_match 検索結果のサブドメインも考慮する? (0 または 1), 0 がデフォルト
exact_url 完全一致 URL? (0 または 1), 0 がデフォルト
check_freq 順位チェック頻度 (‘check_daily’,’check_1in3′,’check_weekly’, ‘check_monthly’, ‘manual’), check_daily がデフォルト
site_group_id 新規追加されたプロジェクトのグループ ID
check_day 週毎のチェック頻度(check_weekly)の場合、このパラメータは曜日が示されます。 (1 – 月曜日 から 7 –日曜日) 月毎のチェック頻度(check_monthly)の場合、このパラメータは日付が示されます。 (1 – 31)
is_active プロジェクトステータス 1 – active, 0 – delayed

結果

成功すると、サーバーは 200 HTTP コードを返します。

プロジェクトの削除

このメソッドはユーザーアカウントからプロジェクトを削除する事ができます。

リクエスト フォーマット

DELETE https://api4.seranking.com/sites/{site_id}

結果

成功すると、サーバーは 204 HTTP コードを返します。

キーワードの削除

このメソッドはプロジェクトからキーワードを削除する事ができます。

リクエスト フォーマット

DELETE https://api4.seranking.com/sites/{site_id}/keywords?keywords_ids[]=1&keywords_ids[]=2&keywords_ids[]=3

リクエスト パラメータ

名称 必須 説明
keywords_ids はい 削除するキーワードのIDの配列

結果

成功すると、サーバーは 204 HTTP コードを返します。

エラー

HTTP コード エラーメッセージ/th>
400 No ids in request

手動順位設定

このメソッドはプロジェクトのキーワード順位を設定する事ができます。

リクエスト フォーマット

PUT https://api4.seranking.com/sites/{site_id}/position/
{
“keyword_id”: 1,
“date”: “2018-01-01”,
“position”:100,
“site_engine_id”: 1
}

リクエスト パラメータ

名称 必須 タイプ 説明
keyword_id はい ユニーク キーワード ID (GET https://api4.seranking.com/sites/{site_id}/keywords を参照)
date はい yyyy-mm-dd 設定される順位の日付
site_engine_id はい ユニーク プロジェクト 検索エンジン ID ( GET https://api4.seranking.com/sites/{site_id}/search-engines を参照)
position はい 0 から 200までの順位。 0 は “not found” とみなされます

結果

成功すると、サーバーは 200 HTTP コードを返します。

エラー

HTTP コード エラーメッセージ
400 Invalid date
400 Invalid keyword_id
400 Unknown site_engine_id

順位チェックの実行

このメソッドは、プロジェクト全体、または特定のキーワードの順位チェックを実行します。

リクエスト フォーマット

POST https://api4.seranking.com/api/sites/{site_id}/recheck/
{
“keywords”:[
{
“site_engine_id”:1,
“keyword_id”:2
}
]
}

パラメータ

名称 必須 説明
site_engine_id いいえ ユニーク プロジェクト 検索エンジン ID。APIリクエストにこのパラメータを含めた場合、順位チェックは指定された検索エンジンのみで行われます。
keywords はい 順位チェックを行うキーワードごとの配列。キーワードごとに指定できます:: site_engine_id (ユニーク プロジェクト 検索エンジン ID) と keyword_id (ユニーク キーワード ID)。APIリクエストにこのパラメータが含まれていると、 site_engine_id パラメータは無視されます。

結果

成功すると、サーバーは順位チェックが行われたキーワードの配列を返します。

名称 必須 説明
total はい 順位チェックが実施されたキーワードの数

レスポンス例

{
“total”: 5
}

エラー

HTTP コード エラーメッセージ
400 Unknown site_engine_id