---
title: metrics
description: 指標カタログを確認し、Workspace の指標を集計します。
canonical_url: https://orchestor.io/docs/cli/metrics
markdown_url: https://orchestor.io/docs/cli/metrics.md
contentType: reference
---

# metrics

`orc metrics list` は全データセットを返します。`orc metrics get DATASET` は1件の定義を返します。各定義には指標の単位・加算可否・意味型、集計軸と許可フィルターが含まれます。`orc metrics query` はカタログの指標と集計軸を指定してデータを集計します。`--date-range` は JSON オブジェクトで指定し、`--stdin` でクエリ全体も渡せます。

## 使い方

```bash title="terminal"
orc metrics list --workspace YOUR_WORKSPACE_ID --json
```

*指標カタログを読む*

## サブコマンド

### `list`

List metric datasets

```bash title="terminal"
orc metrics list [options]
```

### `get`

Get a metric dataset

```bash title="terminal"
orc metrics get <dataset> [options]
```

### `query`

Query metrics

```bash title="terminal"
orc metrics query [options]
```

#### 固有のオプション

##### `--dataset`

(required) Body field: dataset; enum: visibility|citations|sentiment|query-fanouts|web-search-results|perception

型: `string`。任意。

```bash title="terminal"
orc metrics query --dataset <value>
```

##### `--date-range`

(required) Body field: date_range

型: `string`。任意。

```bash title="terminal"
orc metrics query --date-range <value>
```

##### `--dimensions`

(required) Body field: dimensions; csv of: brand|platform|model|topic|prompt|source_domain|source_page|search_query|result_hostname|result_url|attribute|date

型: `string`。任意。

```bash title="terminal"
orc metrics query --dimensions <value>
```

##### `--filters`

Body field: filters; (JSON object, e.g. '{"custom_id":"x"}')

型: `string`。任意。

```bash title="terminal"
orc metrics query --filters <value>
```

##### `--granularity`

Body field: granularity; enum: day|week|month

型: `string`。任意。

```bash title="terminal"
orc metrics query --granularity <value>
```

##### `--metrics`

(required) Body field: metrics; csv of: visibility_rate|share_of_voice|average_position|mention_count|citation_count|citation_rate|sentiment_score|fanout_count|web_search_result_count|search_share|attribute_mention_count|answer_count

型: `string`。任意。

```bash title="terminal"
orc metrics query --metrics <value>
```

##### `--order-by`

Body field: order_by; JSON array of objects (use --stdin for large resources)

型: `string`。任意。

```bash title="terminal"
orc metrics query --order-by <value>
```

## 使用例

### 可視性の定義を読む

```bash title="terminal"
orc metrics get visibility --workspace YOUR_WORKSPACE_ID --json
```

*可視性の定義を読む*

### 30日間の可視性を集計する

```bash title="terminal"
orc metrics query --dataset visibility --metrics visibility_rate --dimensions date --date-range '{"period":"30d"}' --workspace YOUR_WORKSPACE_ID --json
```

*30日間の可視性を集計する*

## 必要な権限

ログインと Workspace へのアクセスが必要です。

## グローバルオプション

`orc metrics` では、次の[グローバルオプション](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)
- [`--limit`](https://orchestor.io/docs/cli/global-flags.md)
- [`--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)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97)
- [`--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)
- [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89)
- [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91)

各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。

---

[Documentation index](https://orchestor.io/docs/llms.txt)