​

dashboards

orc dashboards list lists dashboards. get SLUG reads a dashboard with its Spec v2. pull is an alias for get. Use pull SLUG --raw --output dashboard.json to save response data as JSON. Edit title or spec, check structure and metric catalog membership with validate --stdin < dashboard.json, then save a draft with push SLUG --stdin < dashboard.json. Viewers continue to see the published content. Review the draft with pull SLUG --state draft --raw --output draft.json, then publish with publish SLUG --version VERSION or discard with discard SLUG --version VERSION. Use the version returned by the draft pull. get/pull default to published state. A new slug creates an empty published dashboard and the pushed draft. Without a draft, pull --state draft returns 404 and publish/discard return 409. Files saved with pull include version to detect concurrent edits. Pull again after a 409 conflict caused by concurrent edits. Pushing a dashboard deleted since the pull returns 409. To recreate it, remove version from the file and push again. Omit version when creating a new dashboard. Saving identical content preserves version. schema --raw returns the Spec v2 JSON Schema. schema is a reserved slug for JSON Schema discovery. Standard input accepts JSON only; YAML input is not supported.

List dashboards

orc dashboards render SLUG executes published elements in layout order and returns each compiled MetricQuery and result. Use --state draft to render a draft; a missing draft returns 404. Results default to 20 rows per element; --rows accepts 1 to 10000. row_count counts rows returned by the engine before local truncation. has_more indicates local truncation or more upstream data. A failed element returns error while other elements continue. An element that fails compilation omits query. Use --elements brands,visibility to select names; results retain layout order. Unknown names return 400. For more data, run orc dashboards render SLUG --elements brands --rows 10000 --workspace YOUR_WORKSPACE_ID --json. You can also save one returned query as query.json and run orc metrics query --workspace YOUR_WORKSPACE_ID --stdin < query.json. Select fewer elements or rows if long strings or large results exceed the MCP response limit. Rendering returns data without generating images or PDFs.

orc dashboards templates --workspace YOUR_WORKSPACE_ID --json lists all five templates with id, title, description, and Spec v2. This follows the existing single-level command convention. orc dashboards create-from-template --template-id visibility-overview --workspace YOUR_WORKSPACE_ID --json creates a published dashboard using the same conversion as the editor. --title defaults to the template title. --slug overview uses that exact slug or returns 409 if taken. Omit it to derive an available slug from the title. schema, templates, and from-template are reserved slugs. MCP tools are render_dashboard, list_dashboard_templates, and create_dashboard_from_template.

List dashboards

Get dashboard Spec v2 JSON Schema

Validate a dashboard without saving

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

Type: string. Optional.

Get a dashboard

enum: published|draft

Type: string. Optional.

Create or update a dashboard draft by slug

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

Type: string. Optional.

(required) Body field: title; max 120 chars

Type: string. Optional.

Body field: version

Type: number. Optional.

Discard a dashboard draft

Body field: version

Type: number. Optional.

Publish a dashboard draft

Body field: version

Type: number. Optional.

Create a published dashboard from a template

Body field: slug

Type: string. Optional.

(required) Body field: template_id; enum: visibility-overview|citation-overview|competitive-proposal|content-opportunities|brand-perception

Type: string. Optional.

Body field: title; max 120 chars

Type: string. Optional.

List dashboard templates

Render dashboard element data

enum: published|draft

Type: string. Optional.

value

Type: number. Optional.

Comma-separated element names; results remain in layout order; max 5049 chars

Type: string. Optional.

Get a dashboard

enum: published|draft

Type: string. Optional.

Edit and save a file

Sign in and select a Workspace you can access. API keys need read scope for reads and validation, and write scope to push, publish, discard, and create from templates.

The following global options can be used with orc dashboards:

For details and examples, see global options.