Reports

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.

Usage

terminal
orc report --workspace <workspace-id>

Display a 30-day digest.

Unique options

--period

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

Type: string. Optional.

terminal
orc report --period <value>

Examples

Save a Markdown digest.

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 can be used with orc report:

For details and examples, see global options.