---
title: metrics
description: Inspect the metric catalog and query Workspace metrics.
canonical_url: https://orchestor.io/docs/en/cli/metrics
markdown_url: https://orchestor.io/docs/en/cli/metrics.md
contentType: reference
---

# metrics

`orc metrics list` returns all dataset definitions. `orc metrics get DATASET` returns one definition. Each includes metric units, additivity, semantic types, dimensions, and allowed filters. `orc metrics query` aggregates data using catalog metrics and dimensions. Pass `--date-range` as a JSON object, or supply the entire query with `--stdin`.

## Usage

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

*Read the metric catalog*

## Subcommands

### `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]
```

#### Unique options

##### `--dataset`

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

Type: `string`. Optional.

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

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

(required) Body field: date_range

Type: `string`. Optional.

```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

Type: `string`. Optional.

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

##### `--filters`

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

Type: `string`. Optional.

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

##### `--granularity`

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

Type: `string`. Optional.

```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

Type: `string`. Optional.

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

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

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

Type: `string`. Optional.

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

## Examples

### Read visibility definitions

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

*Read visibility definitions*

### Query visibility over 30 days

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

*Query visibility over 30 days*

## Permissions

Sign in and select a Workspace you can access.

## Global Options

The following [global options](https://orchestor.io/docs/cli/global-flags.md) can be used with `orc metrics`:

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#help)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#workspace)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#output-format)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#raw-output)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#file-output)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#pager)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#dry-run)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#confirmation)
- [`--limit`](https://orchestor.io/docs/cli/global-flags.md)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#all-pages)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#request-timing)
- [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#read-only-mode)
- [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#untrusted-content-wrapping)

For details and examples, see [global options](https://orchestor.io/docs/cli/global-flags.md).

---

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