---
title: report
description: Summarize Workspace visibility, sentiment, and citations.
canonical_url: https://orchestor.io/docs/en/cli/report
markdown_url: https://orchestor.io/docs/en/cli/report.md
contentType: reference
---

# report

`orc report` retrieves visibility, sentiment, and citation reports for a Workspace and combines them into a digest. The default period is 30 days; `--period` accepts `7d`, `30d`, or `90d`.

A Workspace ID is required. Supply `--workspace` or `ORCHESTOR_WORKSPACE_ID`. To select individual metrics or aggregation options, use [`orc reports`](https://orchestor.io/docs/en/cli/reports.md).

## Usage

```bash title="terminal"
orc report --workspace <workspace-id>
```

*Display a 30-day digest.*

## Unique options

### `--period`

Report period: 7d|30d|90d (default: 30d)

Type: `string`. Optional.

```bash title="terminal"
orc report --period <value>
```

## Examples

### Save a Markdown digest.

```bash title="terminal"
orc report --workspace <workspace-id> --period 7d --format markdown --output report.md
```

*Save a Markdown digest.*

## Permissions

Authenticate and select the target Workspace. Access to that Workspace is required.

## Global Options

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

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