APIマニュアル
ご利用について
- 本APIはKEYWORD FINDER COMPACT有料版のご契約者様のみご利用いただけます。
- 本APIのご利用にはAPIキーが必要となります。アカウント管理画面にて作成・確認できます。
- リクエストに関する制限は現在のところ設けておりませんが、リクエスト回数増大に伴うサーバー負荷が著しいと弊社が判断した場合、制限を設けさせていただく可能性がございます。
- 本APIに関するご意見・ご質問は、ログイン後の画面右下に表示される「？」ボタンのメッセージ画面からお寄せください。
レスポンスフォーマットについて
レスポンスフォーマットは、各エンドポイントの拡張子を変更すると切り替えることができます。
対応形式は以下のとおりです。
（初期値は「.json」です）
| 拡張子 | 説明 |
|---|---|
| .xml | XML形式にてデータが表示されます(出力文字エンコードはUTF-8のみ対応) ※ベースノード名は「xml」です |
| .json | JSON形式にてデータが表示されます |
| .php | PHPの配列をダンプした文字列が表示されます |
| .serialized | PHPでunserialize可能なシリアライズデータが表示されます |
キーワード候補・ファインダビリティ取得
リクエストされたURL/キーワードの情報を元に関連キーワードを取得し、取得キーワード全体のファインダビリティを計算する
エンドポイント
リクエストメソッド
GET / POST
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| apikey | varchar | ◎ |
API認証キー |
| keyword | varchar | ※ |
調査対象キーワード ※URLかキーワードのどちらかは必須入力となります |
| url | varchar | ※ |
調査対象URL ※URLかキーワードのどちらかは必須入力となります |
レスポンスパラメータ（階層構造はドットで表現しています）
| パラメータ名 | 型 | 説明 |
|---|---|---|
| result | bool |
処理結果 |
| error | varchar |
処理結果が失敗の場合、エラー内容を格納 |
| keyword | bool / array |
候補キーワード情報 |
| keyword.data.keyword | varchar |
候補キーワード文字列 |
| keyword.data.search_volume | int |
月間検索数 |
| keyword.data.seo_difficulty | int(null) |
SEO難易度 |
| keyword.data.bid | int |
CPC（リスティング広告入札単価） |
| findability | bool / array |
ファインダビリティ情報 |
| findability.data.rid | int |
リクエストID |
| findability.data.domain | varchar |
ドメイン文字列 |
| findability.data.rank | int |
ファインダビリティ順位 |
| findability.data.score | int |
ファインダビリティスコア |
| findability.data.scheme | varchar |
対象ドメインのURLスキーム |
サンプルリクエストURL
ファインダビリティ詳細データ取得
調査結果のファインダビリティ一覧内、ドメイン別の検索結果調査情報を取得する
エンドポイント
リクエストメソッド
GET / POST
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| apikey | varchar | ◎ |
API認証キー |
| domain | varchar | ◎ |
ファインダビリティ一覧に含まれるドメイン文字列 |
| rid | int | ◎ |
ファインダビリティ一覧に含まれるリクエストID |
レスポンスパラメータ（階層構造はドットで表現しています）
| パラメータ名 | 型 | 説明 |
|---|---|---|
| result | bool |
処理結果 |
| error | varchar |
処理結果が失敗の場合、エラー内容を格納 |
| data.keyword | varchar |
調査対象キーワード文字列 |
| data.rank | int |
検索順位 |
| data.lp | varchar |
検索結果ランクインURL |
サンプルリクエストURL
調査状態確認
調査対象URL/キーワードの現在の調査段階を表示
エンドポイント
リクエストメソッド
GET / POST
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| apikey | varchar | ◎ |
API認証キー |
| keyword | varchar | ※ |
調査対象キーワード ※URLかキーワードのどちらかは必須入力となります |
| url | varchar | ※ |
調査対象URL ※URLかキーワードのどちらかは必須入力となります |
レスポンスパラメータ（階層構造はドットで表現しています）
| パラメータ名 | 型 | 説明 |
|---|---|---|
| result | bool |
処理結果 |
| error | varchar |
処理結果が失敗の場合、エラー内容を格納 |
| status | varchar |
調査状態を表す文字列
|