research boxil
BOXIL のカテゴリ、製品、レビュー、記事を調査します。掲載位置、スポンサー表示、資料請求ランキングを区別して比較します。
使い方
orc research boxil categories list --q 電子契約 --workspace YOUR_WORKSPACE_ID --jsonカテゴリを検索する
サブコマンド
article get
articleを取得します。
orc research boxil article get <id> [options]categories list
カテゴリを一覧取得します。
orc research boxil categories list [options]固有のオプション
--q
max 200 chars
型: string。任意。
orc research boxil categories list --q <value>products list
製品を一覧取得します。
orc research boxil products list <slug> [options]固有のオプション
--page
value
型: number。任意。
orc research boxil products list <slug> --page <value>ranking get
資料請求ランキングを取得します。
orc research boxil ranking get <slug> [options]discovery get
公開ディスカバリー情報を取得します。
orc research boxil discovery get [options]固有のオプション
--kind
enum: robots|llms|sitemap|mag-sitemap
型: string。任意。
orc research boxil discovery get --kind <value>product get
productを取得します。
orc research boxil product get <id> [options]reviews list
レビューを一覧取得します。
orc research boxil reviews list <id> [options]固有のオプション
--page
value
型: number。任意。
orc research boxil reviews list <id> --page <value>search
製品を検索します。
orc research boxil search [options]固有のオプション
--page
value
型: number。任意。
orc research boxil search --page <value>--q
max 70 chars
型: string。必須。
orc research boxil search --q <value>使用例
カテゴリの製品を取得する
orc research boxil products list electronic_contract --page 1 --workspace YOUR_WORKSPACE_ID --jsonカテゴリの製品を取得する
製品の詳細を取得する
orc research boxil product get 611 --workspace YOUR_WORKSPACE_ID --json製品の詳細を取得する
取得結果と使い方
APIの返却値は data、source、coverage、warnings、interpretation です。CLIの --json ではこれがCLI出力エンベロープの data に入ります。source.observed_at は取得日時です。
製品一覧の position は掲載位置です。sponsored でPR表示を確認し、同じ製品の重複掲載を考慮してください。ランキングは資料請求に基づき、満足度順位ではありません。未評価・不明な料金は null です。
orc research boxil products list、orc research boxil reviews list、orc research boxil search は自動で全ページを収集しません。API返却値の data.next_url はBOXIL側のURLです。次ページがある場合は、その page に対応する値を --page に指定します。原典URLをOrchestor APIとして呼ばないでください。
BOXIL APIの仕様と取得範囲も参照してください。
必要な権限
orc auth login でベータ承認済みアカウントにログインするか、read スコープの API キーを使用します。アクセスできる Workspace を --workspace で指定します。research 専用の Workspace 許可リストは不要です。
グローバルオプション
orc research boxil では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。