--- title: research boxil description: BOXIL のカテゴリ、製品、レビュー、記事を調査します canonical_url: https://orchestor.io/docs/cli/research/boxil markdown_url: https://orchestor.io/docs/cli/research/boxil.md contentType: reference --- # research boxil BOXIL のカテゴリ、製品、レビュー、記事を調査します。掲載位置、スポンサー表示、資料請求ランキングを区別して比較します。 ## 使い方 ```bash title="terminal" orc research boxil categories list --q 電子契約 --workspace YOUR_WORKSPACE_ID --json ``` *カテゴリを検索する* ## サブコマンド ### `article get` articleを取得します。 ```bash title="terminal" orc research boxil article get [options] ``` ### `categories list` カテゴリを一覧取得します。 ```bash title="terminal" orc research boxil categories list [options] ``` #### 固有のオプション ##### `--q` max 200 chars 型: `string`。任意。 ```bash title="terminal" orc research boxil categories list --q ``` ### `products list` 製品を一覧取得します。 ```bash title="terminal" orc research boxil products list [options] ``` #### 固有のオプション ##### `--page` value 型: `number`。任意。 ```bash title="terminal" orc research boxil products list --page ``` ### `ranking get` 資料請求ランキングを取得します。 ```bash title="terminal" orc research boxil ranking get [options] ``` ### `discovery get` 公開ディスカバリー情報を取得します。 ```bash title="terminal" orc research boxil discovery get [options] ``` #### 固有のオプション ##### `--kind` enum: robots|llms|sitemap|mag-sitemap 型: `string`。任意。 ```bash title="terminal" orc research boxil discovery get --kind ``` ### `product get` productを取得します。 ```bash title="terminal" orc research boxil product get [options] ``` ### `reviews list` レビューを一覧取得します。 ```bash title="terminal" orc research boxil reviews list [options] ``` #### 固有のオプション ##### `--page` value 型: `number`。任意。 ```bash title="terminal" orc research boxil reviews list --page ``` ### `search` 製品を検索します。 ```bash title="terminal" orc research boxil search [options] ``` #### 固有のオプション ##### `--page` value 型: `number`。任意。 ```bash title="terminal" orc research boxil search --page ``` ##### `--q` max 70 chars 型: `string`。必須。 ```bash title="terminal" orc research boxil search --q ``` ## 使用例 ### カテゴリの製品を取得する ```bash title="terminal" orc research boxil products list electronic_contract --page 1 --workspace YOUR_WORKSPACE_ID --json ``` *カテゴリの製品を取得する* ### 製品の詳細を取得する ```bash title="terminal" 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` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。 - [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93) 各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。 --- [Documentation index](https://orchestor.io/docs/llms.txt)