競合
プロジェクトに競合を追加
このメソッドはプロジェクトに順位チェックを行う競合を追加する事ができます。
パラメータ
| 名称 | 必須 | 説明 |
| url | はい | 競合のウェブサイト URL |
| site_id | はい | ユニーク プロジェクト ID |
| name | いいえ | 競合のウェブサイト名 (指定がなければURLが使用されます) |
| subdomain_match | いいえ | サブドメインを考慮(1 – はい , 0 – いいえ) |
リクエスト フォーマット
POST /competitors
{
site_id : 1,
name : "name",
url : "http://site.test.com/"
}結果
成功すると、サーバーは 201 HTTP コードと、追加された競合の ID を返します。
| 名称 | 必須 | 説明 |
| id | はい | 競合のユニーク ID |
レスポンス例
{
"id": 123456
}エラー
| HTTP コード | エラーメッセージ |
| 400 | Invalid site url |
プロジェクトの競合のリスト取得
このメソッドは、プロジェクトに追加された全ての競合のリストを取得する事ができます。
リクエスト フォーマット
GET /competitors/site/{site_id}結果
成功すると、サーバーは競合サイトの統計とともに、プロジェクトに追加された競合のリストの配列を返します。
| 名称 | 必須 | 説明 |
| url | はい | 競合 URL |
| id | はい | 競合 ID |
| name | はい | 競合 名 |
レスポンス例
[
{
"id": 1,
"name": "competitor1.com",
"url": "competitor1.com",
},
{
"id": 2,
"name": "competitor2.com",
"url": "http://competitor2.com/",
},
{
"id": 3,
"name": "competitor3.com",
"url": "http://competitor3.com",
}
]競合のキーワード順位
このメソッドは、プロジェクトに追加された競合順位の統計を取得する事ができます。
リクエスト フォーマット
GET /competitors/{competitor_id}/positions?date_from=2018-07-25&date_to=2018-07-25&site_engine_id=1
リクエスト クエリ パラメータ
| 名称 | 必須 | 形式 | 説明 |
| date_from | いいえ | yyyy-mm-dd | 期間の開始日 (デフォルトでは今日から一週間前) |
| date_to | いいえ | yyyy-mm-dd | 期間の終了日 (デフォルトでは今日) |
| site_engine_id | いいえ | yyyy-mm-dd | 検索エンジン ID。 指定されていなければ、全ての検索エンジンのデータが返されます。 |
| with_serp_features | いいえ | キーワード検索結果で検知されたGoogleのSERP要素 |
結果
成功すると、サーバーはプロジェクトに追加された競合キーワードの順位統計を返します。
| 名称 | 必須 | 説明 |
| id | はい | Iプロジェクトに追加されたクエリのID |
| positoins | はい | 競合キーワードランキングを含む順位の配列 |
| date | はい | キーワード順位チェック日 |
| change | はい | 前回の日付と比較した順位の差 (マイナスもあり得ます) |
| pos | はい | 現在の順位 |
レスポンス例
[
{
"site_engine_id": 123,
"keywords": [
{
"id": "123",
"positions": [
{
"date": "2018-07-25",
"pos": 7,
"change": 1
}
],
"name": null,
"volume": null
},
...
]エラー
| HTTP コード | エラーメッセージ |
| 400 | Invalid site_engine_id |
| 404 | Incorrect competitor id |
プロジェクトから競合を削除
このメソッドは、ユーザー プロジェクトから競合のサイトを削除する事ができます。
リクエスト フォーマット
DELETE /competitors/{competitor_id}結果
成功すると、サーバーは 204 HTTP コードを返します。
エラー
| HTTP コード | エラーメッセージ |
| 404 | Incorrect competitor id |
キーワードのTOP 10取得
このメソッドは、プロジェクトで追跡しているキーワードのTOP 10のリストを取得する事ができます。
リクエスト フォーマット
GET /competitors/top10/{site_id}/?date=2018-01-01&site_engine_id=1&keyword_id=1リクエスト クエリ パラメータ
| 名称 | 必須 | 形式 | 説明 |
| date | はい | yyyy-mm-dd | TOP 10 のサイトのリスト取得日 |
| keyword_id | はい | プロジェクトに追加されたクエリの ID (取得するには GET /sites/{site_id}/keywordsを使用)。 | |
| site_engine_id | はい | 検索エンジン ID |
結果
成功すると、サーバーはTOP 10のサイトの配列を返します。
| 名称 | 説明 |
| url | ページ URL |
| position | 検索結果の順位 |
| keyword_id | ユニーク キーワード ID |
| Backlinks | 合計被リンク |
| domains | 参照しているユニークドメイン数 |
| yandex_x | 訪問者にとっての競合サイトの利便性を示すYandexのサイト品質インデックス。 |
レスポンス例
[
{
"url": "https://www.tests.com/login",
"position": 1,
"keyword_id": 1,
"da": null,
"backlinks": "328",
"domains": "32",
"yandex_x": null
},
...
]キーワードのTOP 100 の取得
このメソッドは、プロジェクトで追跡しているキーワードのTOP 100 のリストを取得する事ができます。
GET /competitors/top100/{site_id}/?date=2018-01-01&site_engine_id=1&keyword_id=1
リクエスト クエリ パラメータ
| 名称 | 必須 | 形式 | 説明 |
| date | はい | yyyy-mm-dd | 日付 |
| keyword_id | はい | プロジェクトに追加されたキーワードのID(取得するには、GET /sites/{site_id}/keywords を使用)。 | |
| site_engine_id | はい | 検索エンジン ID | |
| top | いいえ | 0…100 | M最大順位 |
結果
成功すると、サーバーはTOP 100のサイトの配列を返します。
| 名称 | 説明 |
| url | ページ URL |
| position | 検索結果の順位 |
| date | 順位チェックの日付 |
レスポンス例
[
{
"url": "https://www.tests.com/login",
"position": 1,
"date": "2018-01-01"
},
{
"url": "https://www.test2.com,
"position": 2,
"date": "2018-01-01"
},
...
]タグの削除
ここでは追跡中の各クエリでTOP 10に位置するサイトのデータを確認する事ができます。履歴は14日間保持されます。
リクエスト フォーマット
GET /competitors/all/{site_id}/?date=2018-01-01&site_engine_id=1&group_id=1&tags[]=21
リクエスト クエリ パラメータ
| 名称 | 必須 | 形式 | 説明 |
| date | はい | yyyy-mm-dd | TOP 10 のサイトのリストを受信した日付 |
| group_id | いいえ | キーワード グループ ID。指定されていなければ、全てのキーワード グループのデータが返されます。 | |
| site_engine_id | いいえ | 検索エンジン ID。指定されていなければ、全ての検索エンジンのデータが返されます。 | |
| tags | いいえ | タグの配列 |
結果
成功すると、サーバーはTOP 10のサイトの配列を返します。
| 名称 | 説明 |
| domain_id | ドメイン ID |
| domain | 競合のドメイン |
| visibility | 競合のヴィジビリティ |
| backlinks | 合計被リンク |
| domains | ユニークドメイン参照数 |
| yandex_x | 訪問者にとっての競合サイトの利便性を示すYandexのサイト品質インデックス。 |
レスポンス例
[
{
"domain": "www.tests.com",
"domain_id": 10,
visibility": 0,
"da": null,
"backlinks": "328",
"domains": "32",
"yandex_x": null
},
...
]
