mammoth dashboard
Generated from mammoth-cli 2.4.2, released 2026-11-02:
mammoth schema list,mammoth capability listand the CLI's own--help. Do not edit by hand; runnpm run docs:capabilities.
Build, query, and publish dashboards. 167 commands.
Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.
Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.
Summary
| Command | What it does | Effect | Confirmation |
|---|---|---|---|
dashboard action | Apply a lifecycle action to a dashboard. Always requires '--yes'. | External effect | --yes |
dashboard analytics | Get analytics for one dashboard by id. | Read | — |
dashboard archive | Set the archived state of one dashboard with exact target confirmation. | High impact | --yes --confirm TARGET |
dashboard assess-pbix | Assess a local Power BI workbook through the SDK multipart seam. | Read | — |
dashboard assess-twb | Assess a local Tableau workbook through the SDK multipart seam. | Read | — |
dashboard attachment-create | Upload a local workbook as a chat attachment. File path is positional. | Benign mutation | — |
dashboard bi-export | Download this dashboard as a Power BI project (.zip) or Tableau workbook (.twbx). | Read | — |
dashboard bi-preflight | What a Power BI or Tableau export of this dashboard would carry. | Read | — |
dashboard cancel-generation | Cancel an in-progress dashboard generation. | Benign mutation | — |
dashboard columns | Get every column of a board's source dataset with its profile. | Read | — |
dashboard create-blank | Create an empty v3 dashboard bound to a dataview. | Benign mutation | — |
dashboard delete | Permanently delete one dashboard by id. Prompt or '--yes' required. | Destructive | --yes or prompt |
dashboard descriptor-data | Start an asynchronous fetch of a dashboard's descriptor data. | Benign mutation | — |
dashboard duplicate | Copy a v3 dashboard; with 'target_dataview_id' also wait for its data swap. | Benign mutation | — |
dashboard figure-intent | Resolve an AI-add figure from an intent. | Benign mutation | — |
dashboard format-preview | Dry-run a format switch: what carries over, what is added, what is lost. | Read | — |
dashboard get | Get one dashboard by id, with each KPI card's and tile's number and period. | Read | — |
dashboard get-by-url | Get one dashboard by its share url slug. | Read | — |
dashboard import-workbook | Import a local workbook into a confirmed project scope. | High impact | --yes --confirm TARGET |
dashboard job-by-url | Get a job's status for a dashboard by URL and job-id positionals. | Read | — |
dashboard list | List dashboards in the active workspace. | Read | — |
dashboard oembed | oEmbed provider — a pasted board link, as a live embed. | Read | — |
dashboard og-card | Dashboard card thumbnail (draft or published PNG). | Read | — |
dashboard pbix-assess | Run a workbook read on an attachment (intent or assess) and return the job's result. | Read | — |
dashboard pbix-intent | Run a workbook read on an attachment (intent or assess) and return the job's result. | Read | — |
dashboard pdf-artifact | Download a completed draft PDF export. | Read | — |
dashboard published-data-by-url | Run a published-data request for a dashboard by url. 'body' from '--input'. | Benign mutation | — |
dashboard query | Run an ad-hoc descriptor query from the editor. | Benign mutation | — |
dashboard restore | Restore a trashed dashboard. | Benign mutation | — |
dashboard share | Share a dashboard. Always requires '--yes'. | External effect | --yes |
dashboard swap-data | Re-point a v3 dashboard at a different dataset. | Benign mutation | --yes --confirm TARGET |
dashboard swap-fit | Score one board against candidate datasets before 'swap_data' (no writes). | Read | — |
dashboard trash | Move one dashboard to the trash (reversible). | Benign mutation | — |
dashboard unpublished | Draft changes since the published version. | Read | — |
dashboard update | Apply a JSON Patch to one dashboard. Dashboard id is positional. | Benign mutation | — |
dashboard video-state | Motion-story video export state (never kicks a render). | Read | — |
dashboard widget-data | Run a widget-data request for a dashboard by id. 'body' from '--input'. | Benign mutation | — |
dashboard widget-data-by-url | Run a widget-data request for a dashboard by url. 'body' from '--input'. | Benign mutation | — |
dashboard audience digest get | Get the caller's weekly audience email setting for one board. | Read | — |
dashboard audience digest set | Store the caller's choice for one board's weekly audience email. | Benign mutation | — |
dashboard audience get | Get who read a board: totals, daily series, viewers, reach and actions. | Read | — |
dashboard audience summary | Get views per board for the dashboard library: several boards in one call. | Read | — |
dashboard canvas get | Get a dashboard's draft canvas, as the editor shows it. | Read | — |
dashboard canvas restore | Undo, redo or revert the draft canvas to a target version. | Benign mutation | — |
dashboard canvas save | Save the draft canvas as a new version. | Benign mutation | — |
dashboard chart-type create | Save a custom chart as a workspace chart type (owners, admins and members). | Benign mutation | — |
dashboard chart-type delete | Delete a workspace chart type (workspace owners, admins and members). | Destructive | --yes or prompt |
dashboard chart-type list | List the workspace's saved chart types, newest first. | Read | — |
dashboard chat attachment upload | Attach a local file to a dashboard's editor chat; the result's 'ref' goes in a turn. | Benign mutation | — |
dashboard chat edit | Send one chat message that edits the dashboard. | Benign mutation | — |
dashboard chat history | Get a dashboard's editor chat transcript. | Read | — |
dashboard context apply | Write the candidate a context review proposed, as a new canvas version. | Benign mutation | --yes --confirm TARGET |
dashboard context create | Create a workspace context that dashboards can apply. | Benign mutation | — |
dashboard context delete | Delete a workspace context. | Destructive | --yes or prompt |
dashboard context extract | Extract a context file into slot suggestions (release route). | Benign mutation | — |
dashboard context list | List the workspace's contexts. | Read | — |
dashboard context review | Dry-run what applying a board's current context would change. | Read | — |
dashboard context update | Update a workspace context. | Benign mutation | — |
dashboard data draft | Read one widget's rows from a dashboard's draft state. Fields come from '--input'. | Read | — |
dashboard data published | Read one widget's rows from a dashboard's published state. Fields from '--input'. | Read | — |
dashboard email-updates get | A dashboard's email updates. | Read | — |
dashboard email-updates list | Email updates in this workspace. | Read | — |
dashboard email-updates me get | Whether I get this dashboard's email updates. | Read | — |
dashboard email-updates me set | Turn my email updates for this dashboard back on, or off. | Benign mutation | — |
dashboard email-updates set | Turn a dashboard's email updates on, off, or change them. | External effect | --yes |
dashboard email-updates test | Send me a test email update. | External effect | --yes |
dashboard embed config get | Read a board's embed settings. | Read | — |
dashboard embed config set | Save a board's embed settings (mode, origin allowlist, appearance). | High impact | --yes --confirm TARGET |
dashboard embed key rotate | Create or rotate a board's embed key (Basic embeds). | High impact | --yes --confirm TARGET |
dashboard embed lifetime set | Set how long an embed viewer session lives for a workspace. | Benign mutation | — |
dashboard embed origin revoke | Remove one origin from a board's embed allowlist. | High impact | --yes --confirm TARGET |
dashboard embed preview-token create | Mint a preview token for the embed simulator (editor-only). | Benign mutation | — |
dashboard embed secret rotate | Create or rotate the workspace's embed signing secret (owners/admins). | High impact | --yes --confirm TARGET |
dashboard embed usage get | Get one board's embed registry: origins, tiles and render counts. | Read | — |
dashboard embed usage summary | Count the active embed origins of several boards in one call. | Read | — |
dashboard engagement get | Show who has opened a dashboard: reach, depth, devices and actions. | Read | — |
dashboard engagement person | Show one person's recent visits to a dashboard. Dashboard id and user id are positional. | Read | — |
dashboard engagement remind | Email the share link again to people who have not opened a dashboard. | External effect | --yes |
dashboard exemplar extract | Extract an example report into an editable dashboard spec. | Benign mutation | — |
dashboard figure add | Add one figure to a dashboard, from an intent or an exact figure spec. | Benign mutation | — |
dashboard figure drill | Drill one mark of a draft board's figure one level down (editors). | Read | — |
dashboard figure recipe | Turn a described chart into a figure spec: a library chart, or a custom drawing. | Read | — |
dashboard figure rows | Read the records behind one chart mark or KPI card of a draft board (editors). | Read | — |
dashboard filter add | Add (or replace) the filter control on one column of a board. | Benign mutation | — |
dashboard filter list | List the filter controls a board declares. | Read | — |
dashboard filter remove | Remove the filter control on one column of a board. | Benign mutation | — |
dashboard gallery get | Get one template card from the public gallery. | Read | — |
dashboard gallery list | List the public template gallery: curated, live templates only. | Read | — |
dashboard live-chart audience | Change who can see a live chart. | High impact | --yes --confirm TARGET |
dashboard live-chart create | Make a chat chart live. | Benign mutation | — |
dashboard live-chart get | Read a live chart. | Read | — |
dashboard live-chart list | The charts one chat made live. | Read | — |
dashboard live-chart placement | Record a dashboard the chart was added to. | Benign mutation | — |
dashboard live-chart usage | Where a live chart is used. | Read | — |
dashboard own-data accept | Apply the proposed 'use my data' version to a board; this changes it. | Benign mutation | --yes --confirm TARGET |
dashboard own-data dismiss | Drop a board's pending 'use my data' run; the board is not changed. | Benign mutation | — |
dashboard own-data preview | Preview a board on your own data as proposed, without saving it. | Read | — |
dashboard own-data start | Fit a template board to your own data and wait for the proposal. | Benign mutation | — |
dashboard own-data status | Show a board's pending 'use my data' run; status null means none. | Read | — |
dashboard page plan | Compose a new page from an intent. | Benign mutation | — |
dashboard pages add | Append structural pages and start the asynchronous dashboard bake. | High impact | --yes --confirm TARGET |
dashboard pdf export | Kick a draft-dashboard PDF export. | Benign mutation | — |
dashboard published canvas | Get a published dashboard's viewer canvas. | Read | — |
dashboard published data | Descriptor data for a published dashboard. | Benign mutation | — |
dashboard published drill | Drill one mark of a published board's figure one level down (any viewer). | Read | — |
dashboard published og-card | Published dashboard's link-unfurl OG card (baked PNG). | Read | — |
dashboard published pdf export | Kick a published-dashboard PDF export. | Benign mutation | — |
dashboard published pdf-artifact | Download a completed published PDF export. | Read | — |
dashboard published rows | Read the records behind a mark of a published board (signed-in readers). | Read | — |
dashboard published share-page | Published dashboard's link-unfurl share page (crawler-facing HTML). | Read | — |
dashboard published video export | Kick a motion-story video export (published view). | Benign mutation | — |
dashboard published video-artifact | Stream a published motion-story video (Range-enabled). | Read | — |
dashboard qa ask | Ask one question in a Q&A session; the answer arrives asynchronously. | Benign mutation | — |
dashboard qa comment create | Comment on a shared Q&A session. | Benign mutation | — |
dashboard qa comment delete | Delete a comment (author or session owner). | Destructive | --yes or prompt |
dashboard qa feedback | Rate an assistant answer (up/down; null clears). | Benign mutation | — |
dashboard qa insights | Get the questions viewers asked on a board, grouped by their text. | Read | — |
dashboard qa session create | Create a Q&A session. | Benign mutation | — |
dashboard qa session delete | Delete a Q&A session (owner only). | Destructive | --yes or prompt |
dashboard qa session fork | Fork a shared Q&A session into a private copy. | Benign mutation | — |
dashboard qa session get | Read a Q&A session (replayable — carries baked answers). | Read | — |
dashboard qa session list | List Q&A sessions. | Read | — |
dashboard qa session rename | Rename a Q&A session (owner only). | Benign mutation | — |
dashboard qa session set-visibility | Share/unshare a Q&A session (owner only). | Benign mutation | — |
dashboard qa settings get | Get this dashboard's Q&A settings. | Read | — |
dashboard qa settings set | Update this dashboard's Q&A settings (editors only). | Benign mutation | — |
dashboard rls assignment list | List RLS viewer assignments. | Read | — |
dashboard rls assignment set | Replace RLS viewer assignments. | Benign mutation | — |
dashboard rls column list | Candidate columns for the RLS filter. | Read | — |
dashboard rls value list | Distinct values for an RLS filter column. | Read | — |
dashboard signature create | Create a workspace signature. | Benign mutation | — |
dashboard signature delete | Delete a signature. | Destructive | --yes or prompt |
dashboard signature list | List the workspace's signatures. | Read | — |
dashboard signature update | Update a signature. | Benign mutation | — |
dashboard source list | List dashboard sources available in the active workspace. | Read | — |
dashboard style custom create | Create a workspace custom style. | Benign mutation | — |
dashboard style custom delete | Delete a custom style. | Destructive | --yes or prompt |
dashboard style custom list | List the workspace's custom styles. | Read | — |
dashboard style custom update | Update a custom style. | Benign mutation | — |
dashboard style default get | Get the workspace's default style id. | Read | — |
dashboard style default set | Set the workspace default style id. | Benign mutation | — |
dashboard style derive | Derive a full Style bundle from signals. | Benign mutation | — |
dashboard style extract-brand | Kick a brand extraction from a URL. | Benign mutation | — |
dashboard style preset list | Style presets (stock + custom). | Read | — |
dashboard style token list | Get a full style bundle by id (stock or custom). | Read | — |
dashboard suggestion list | Data-grounded starting points for the create screen. | Read | — |
dashboard tags delete | Delete a workspace dashboard tag after exact-target confirmation. | Destructive | --yes --confirm TARGET |
dashboard tags list | List the workspace dashboard-tag vocabulary. | Read | — |
dashboard tags merge | Merge a source workspace dashboard tag into a target tag. | Destructive | --yes --confirm TARGET |
dashboard tags rename | Rename a dashboard tag. A rename is undone by renaming back, so it asks nothing. | Benign mutation | — |
dashboard tags set | Replace all dashboard tags after exact-target confirmation. | High impact | --yes --confirm TARGET |
dashboard template apply | Apply a template to a target dataset. | Benign mutation | — |
dashboard template create | Save a dashboard as a workspace template. | Benign mutation | — |
dashboard template delete | Delete a saved workspace template. | Destructive | --yes or prompt |
dashboard template fit | Fit-score the whole catalog against one dataset. | Read | — |
dashboard template get | One template's metadata + self-fit recipe. | Read | — |
dashboard template list | Curated template catalog. | Read | — |
dashboard template preview | Preview a template mapping applied to a target dataset. | Benign mutation | — |
dashboard template rename | Rename a saved workspace template. | Benign mutation | — |
dashboard template resolve-mapping | Propose a template mapping onto a target dataset. | Benign mutation | — |
dashboard template thumbnail clear | Remove a saved template's picture; its card falls back to the og-card. | Destructive | --yes or prompt |
dashboard template thumbnail get | Download the picture a template's card shows. | Read | — |
dashboard template thumbnail set | Replace the picture of a saved workspace template. | Benign mutation | — |
dashboard templates pending | Claim the pending dashboard template for the workspace. | Benign mutation | — |
dashboard templates use | Instantiate a dashboard template on its sample data. | High impact | --yes --confirm TARGET |
dashboard v3 generate | Generate a v3 dashboard. | Benign mutation | — |
dashboard video export | Kick a motion-story video export. | Benign mutation | — |
dashboard commands
mammoth dashboard action
Apply a lifecycle action to a dashboard. Always requires '--yes'.
mammoth dashboard action 123 --input '{"action": "sync"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
action | --input field | yes | — | DashboardActionType | One of sync, publish-data, publish-presentation, unpublish, auto-sync, auto-publish, delete-source, restore, set-rls-config. |
params_enabled | --input field | no | — | bool | |
params_view_id | --input field | no | — | int | |
params_sequence | --input field | no | — | int | |
params_filter_column | --input field | no | — | str |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: B13 DASHBOARD_ASYNC_UNTYPED; publish/unpublish/delete-source require exact target confirmation.
- Id:
dashboard.action· Result:DashboardActionResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.action, APIPOST /dashboards/{dashboard_id}/action(DashboardAction)
mammoth dashboard analytics
Get analytics for one dashboard by id.
mammoth dashboard analytics 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.analytics· Result:DashboardAnalyticsResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get_analytics, APIGET /dashboards/{dashboard_id}/analytics(GetDashboardAnalytics)
mammoth dashboard archive
Set the archived state of one dashboard with exact target confirmation.
mammoth dashboard archive 123 --input '{"archived": true}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
archived | --input field | yes | — | bool |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.archive· Result:DashboardArchiveResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.archive, APIPOST /dashboards/{dashboard_id}/archive(ArchiveDashboard)
mammoth dashboard assess-pbix
Assess a local Power BI workbook through the SDK multipart seam.
mammoth dashboard assess-pbix Sales.pbix
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
FILE | positional | yes | — | str | Path to a local workbook. |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: These take a workbook file from the local disk. Inside the Mammoth app the user's file cannot reach the agent: send the user to the dashboard import page at /workspaces/{workspace_id}/publish/import (Publish → Import), where they upload the .pbix/.twb/.twbx themselves.
- Id:
dashboard.assess-pbix· Result:PbixAssessResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.assess_pbix, APIPOST /dashboards/v3/pbix/assess(AssessPbix)
mammoth dashboard assess-twb
Assess a local Tableau workbook through the SDK multipart seam.
mammoth dashboard assess-twb Sales.twb
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
FILE | positional | yes | — | str | Path to a local workbook. |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: These take a workbook file from the local disk. Inside the Mammoth app the user's file cannot reach the agent: send the user to the dashboard import page at /workspaces/{workspace_id}/publish/import (Publish → Import), where they upload the .pbix/.twb/.twbx themselves.
- Id:
dashboard.assess-twb· Result:TwbAssessResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.assess_twb, APIPOST /dashboards/v3/twb/assess(AssessTwb)
mammoth dashboard attachment-create
Upload a local workbook as a chat attachment. File path is positional.
mammoth dashboard attachment-create Sales.pbix
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
FILE | positional | yes | — | str | Path to a local workbook. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Uploads a local workbook as a chat attachment. The attachment id it returns feeds dashboard pbix-intent and dashboard pbix-assess. Inside the Mammoth app the user's file cannot reach the agent, so send the user to the dashboard import page at /workspaces/{workspace_id}/publish/import.
- Id:
dashboard.attachment-create· Result:DashboardAttachmentCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.attachment_create, APIPOST /dashboards/v3/attachments(CreateAttachment)
mammoth dashboard bi-export
Download this dashboard as a Power BI project (.zip) or Tableau workbook (.twbx).
mammoth dashboard bi-export 123 --input '{"target": "powerbi"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
output_path | --input field | no | — | str | Path | None | |
target | --input field | yes | — | Literal['powerbi', 'tableau'] | One of powerbi, tableau. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Author-only, like bi-preflight. Terminal mode writes
output_pathto local disk. Inside the Mammoth app the download cannot reach the user: rundashboard bi-preflightto tell them what will convert, then send them to the dashboard's Publish menu (the arrow next to Publish) -> Export to Power BI / Export to Tableau, where they download the file themselves. No command makes a PDF of a board: that is the board's Download PDF in the app. - Id:
dashboard.bi-export· Result:DashboardBiExportResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.export_powerbi, APIGET /dashboards/{dashboard_id}/tableau/export(TableauExport)
mammoth dashboard bi-preflight
What a Power BI or Tableau export of this dashboard would carry.
mammoth dashboard bi-preflight 123 --input '{"target": "powerbi"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
target | --input field | yes | — | Literal['powerbi', 'tableau'] | One of powerbi, tableau. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Author-only, like the release routes it calls -- a non-author caller is refused, unlike
dashboard pdf export(which any viewer can run). - Id:
dashboard.bi-preflight· Result:PowerBiPreflightResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.powerbi_preflight, APIGET /dashboards/{dashboard_id}/tableau(TableauPreflightHandler)
mammoth dashboard cancel-generation
Cancel an in-progress dashboard generation.
mammoth dashboard cancel-generation 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.cancel-generation· Result:DashboardCancelGenerationResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.cancel_generation, APIPOST /dashboards/{dashboard_id}/cancel-generation(CancelDashboardGeneration)
mammoth dashboard columns
Get every column of a board's source dataset with its profile.
mammoth dashboard columns 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Every column of the board's source dataset with its profile: value samples, measure ranges and aggregates, date spans, and the profiler's identifier and protected-attribute verdicts, plus on_board_count, row_count and signals. Served from the cached dataset profile.
- Id:
dashboard.columns· Result:DashboardColumnsResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.column_roster, APIGET /dashboards/{dashboard_id}/columns(GetColumnRoster)
mammoth dashboard create-blank
Create an empty v3 dashboard bound to a dataview.
mammoth dashboard create-blank --input '{"params": {"dataview_id": 1}}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
params | --input field | yes | — | CreateBlankParams |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: To build a board from a description, use dashboard v3 generate instead. Input is {"params": {"dataview_id": VIEW_ID, "title": ...}} with --yes; returns {id, sequence}. The blank canvas has one page (p1) and no figures: author it with dashboard chat edit, or by hand with dashboard canvas get -> edit -> dashboard canvas save or dashboard pages add. One dataview per dashboard.
- Id:
dashboard.create-blank· Result:DashboardCreateBlankResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.create_blank, APIPOST /dashboards/v3/blank(CreateBlankDashboard)
mammoth dashboard delete
Permanently delete one dashboard by id. Prompt or '--yes' required.
mammoth dashboard delete 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Immutable dashboard-ID confirmation.
- Id:
dashboard.delete· Result:DashboardDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.delete, APIDELETE /dashboards/{dashboard_id}(DeleteDashboard)
mammoth dashboard descriptor-data
Start an asynchronous fetch of a dashboard's descriptor data.
mammoth dashboard descriptor-data 123 --input '{"body": {"params": {"descriptor_ids": ["ef28f9bcc263c0f7"], "filter_state": {"Month": ["2025-01-01", "2025-03-31"]}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | DescriptorDataSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Evaluates baked descriptors by id. Ids come from dashboard canvas get data.meta.figures[<page>:<kpi|add>:<n>].descriptors.value (rows for a table figure) and data.meta.filters. body.params.filter_state is {"<filter field>": value} against the canvas's declared filters: a range control takes [start, end] (dates as YYYY-MM-DD), categorical controls a list of values; an undeclared field is rejected. Results are {descriptor_id: {status, value | data}}. Used to prove a countDistinct card under a Month range (ILG simulation 2026-09-19).
- Id:
dashboard.descriptor-data· Result:DashboardDescriptorDataResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.descriptor_data, APIPOST /dashboards/{dashboard_id}/data(DescriptorData)
mammoth dashboard duplicate
Copy a v3 dashboard; with 'target_dataview_id' also wait for its data swap.
mammoth dashboard duplicate 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
target_dataview_id | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: starts a job; waits or returns it depending on input - Preconditions: Copies the dashboard over the same dataset. Example: mammoth dashboard duplicate 123 --input '{"target_dataview_id": 456}'. With the target_dataview_id input field the copy is made in that view's project and its data swap is queued: the command waits for that job and adds swap_state and swap_result next to id and swap_job_id. project_id (optional) names the project for the copy.
- Id:
dashboard.duplicate· Result:DashboardDuplicateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.duplicate, APIPOST /dashboards/v3/{dashboard_id}/duplicate(DuplicateDashboard)
mammoth dashboard figure-intent
Resolve an AI-add figure from an intent.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard figure-intent 123 --input '{"body": {"params": {"intent": "Summarize revenue by region"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | FigureIntentSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.figure-intent· Result:DashboardFigureIntentResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.figure_intent, APIPOST /dashboards/{dashboard_id}/figure-intent(FigureIntent)
mammoth dashboard format-preview
Dry-run a format switch: what carries over, what is added, what is lost.
mammoth dashboard format-preview 123 --input '{"style": "presentation"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
style | --input field | yes | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Dry run of a format switch on a copy of the canvas: what carries over, what the new style adds, and what the target cannot show (not_shown). Nothing is saved. Take style names from dashboard style preset list.
- Id:
dashboard.format-preview· Result:DashboardFormatPreviewResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.format_preview, APIGET /dashboards/{dashboard_id}/format-preview(FormatPreview)
mammoth dashboard get
Get one dashboard by id, with each KPI card's and tile's number and period.
mammoth dashboard get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.get· Result:DashboardGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get, APIGET /dashboards/{dashboard_id}(GetDashboard)
mammoth dashboard get-by-url
Get one dashboard by its share url slug.
mammoth dashboard get-by-url https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: URL is a slug, not an arbitrary request URL.
- Id:
dashboard.get-by-url· Result:DashboardGetByUrlResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get_by_url, APIGET /dashboards/url/{url}(GetDashboardByUrl)
mammoth dashboard import-workbook
Import a local workbook into a confirmed project scope.
mammoth dashboard import-workbook Sales.twbx --project 456 --yes --confirm 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
FILE | positional | yes | — | str | Path to a local workbook. |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: These take a workbook file from the local disk. Inside the Mammoth app the user's file cannot reach the agent: send the user to the dashboard import page at /workspaces/{workspace_id}/publish/import (Publish → Import), where they upload the .pbix/.twb/.twbx themselves.
- Id:
dashboard.import-workbook· Result:ImportDatasetResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.import_workbook, APIPOST /dashboards/v3/import/dataset(ImportWorkbookDataset)
mammoth dashboard job-by-url
Get a job's status for a dashboard by URL and job-id positionals.
mammoth dashboard job-by-url https://example.com/data.csv 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
JOB_ID | positional | yes | — | int | ID of the job. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL, JOB_ID.
- Id:
dashboard.job-by-url· Result:DashboardJobByUrlResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.job_by_url, APIGET /dashboards/url/{url}/jobs/{job_id}(GetDashboardJob)
mammoth dashboard list
List dashboards in the active workspace.
mammoth dashboard list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.list· Result:DashboardListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.list, APIGET /dashboards(ListDashboard)
mammoth dashboard oembed
oEmbed provider — a pasted board link, as a live embed.
mammoth dashboard oembed
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
url | --input field | no | — | str | |
maxwidth | --input field | no | — | str | |
maxheight | --input field | no | — | str | |
format | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Id:
dashboard.oembed· Result:DashboardOembedResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.oembed, APIGET /dashboards/oembed(Oembed)
mammoth dashboard og-card
Dashboard card thumbnail (draft or published PNG).
mammoth dashboard og-card 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.og-card· Result:DashboardOgCardResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.og_card, APIGET /dashboards/{dashboard_id}/og-card(OgCard)
mammoth dashboard pbix-assess
Run a workbook read on an attachment (intent or assess) and return the job's result.
mammoth dashboard pbix-assess 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
ATTACHMENT_ID | positional | yes | — | int | ID of the attachment. |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Read-only. Assesses a workbook the web app already attached (ATTACHMENT_ID): waits for the job and returns its result. Use dashboard assess-pbix for a local file.
- Id:
dashboard.pbix-assess· Result:DashboardPbixAssessResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.attachment_assess, APIPOST /dashboards/v3/attachments/{attachment_id}/assess(AttachmentAssess)
mammoth dashboard pbix-intent
Run a workbook read on an attachment (intent or assess) and return the job's result.
mammoth dashboard pbix-intent 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
ATTACHMENT_ID | positional | yes | — | int | ID of the attachment. |
TARGET_DATAVIEW_ID | positional | yes | — | int | ID of the target dataview. |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Read-only. Reads a Power BI workbook the web app already attached (ATTACHMENT_ID) against one of your views (TARGET_DATAVIEW_ID), waits for the job and returns its result: intent, coverage {mapped, total}, unmapped_visuals, field_map and target_dataview_id, or {rejected, source}. No dashboard or sample data is made. Uploading the attachment is done in the web app.
- Id:
dashboard.pbix-intent· Result:DashboardPbixIntentResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.attachment_intent, APIPOST /dashboards/v3/attachments/{attachment_id}/intent(AttachmentIntent)
mammoth dashboard pdf-artifact
Download a completed draft PDF export.
mammoth dashboard pdf-artifact 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
JOB_ID | positional | yes | — | int | ID of the job. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, JOB_ID.
- Id:
dashboard.pdf-artifact· Result:DashboardPdfArtifactResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.pdf_artifact, APIGET /dashboards/{dashboard_id}/pdf/{job_id}(GetPdfArtifact)
mammoth dashboard published-data-by-url
Run a published-data request for a dashboard by url. 'body' from '--input'.
mammoth dashboard published-data-by-url https://example.com/data.csv --input '{"body": {"params": {"widget_id": "00000000-0000-4000-8000-000000000001"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: URL.
- Id:
dashboard.published-data-by-url· Result:DashboardPublishedDataByUrlResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_data_by_url, APIPOST /dashboards/url/{url}/getPublishData(GetPublishDataFromSqlByUrl)
mammoth dashboard query
Run an ad-hoc descriptor query from the editor.
mammoth dashboard query 123 --input '{"body": {"params": {"descriptor": {"kind": "scalar", "agg": "count"}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | AdhocQuerySpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.query· Result:DashboardQueryResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.query, APIPOST /dashboards/{dashboard_id}/query(AdhocQuery)
mammoth dashboard restore
Restore a trashed dashboard.
mammoth dashboard restore 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.restore· Result:DashboardRestoreResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.restore, APIPOST /dashboards/{dashboard_id}/restore(RestoreDashboard)
mammoth dashboard share
Share a dashboard. Always requires '--yes'.
mammoth dashboard share 123 --input '{"type_of_auth": "mammoth"}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
type_of_auth | --input field | yes | — | DashboardAuthType | One of mammoth, public, password. |
users | --input field | no | — | list[DashboardShareUser] | |
password_file | --input field | no | — | str |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.share· Result:DashboardShareResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.share, APIPOST /dashboards/{dashboard_id}/share(ShareDashboard)
mammoth dashboard swap-data
Re-point a v3 dashboard at a different dataset.
mammoth dashboard swap-data 123 --input '{"body": {"params": {"dataview_id": 1}}}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | SwapDataSpec |
- Effect: Benign mutation, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.swap-data· Result:ObjectJobSchema· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.swap_data, APIPOST /dashboards/v3/{dashboard_id}/swap-data(SwapDashboardData)
mammoth dashboard swap-fit
Score one board against candidate datasets before 'swap_data' (no writes).
mammoth dashboard swap-fit 123 --input '{"target_dataview_ids": [1]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SOURCE_DASHBOARD_ID | positional | yes | — | int | ID of the source dashboard. |
target_dataview_ids | --input field | yes | — | list[int] | |
include_over_budget | --input field | no | false | bool | |
seconds_budget | --input field | no | — | float |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only check before dashboard swap-data: scores the dashboard (the positional) against up to 60 candidate dataviews, in the order given. Pass target_dataview_ids in --input. Each fit carries a grade (matched, total, reasons) or a skipped reason; too_large means the dataset was not profiled inline, so repeat with include_over_budget for that one. sample_dataview_ids names the template sample data to avoid. No model call, nothing written.
- Id:
dashboard.swap-fit· Result:DashboardSwapFitResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.swap_fit, APIPOST /dashboards/v3/swap/fit(SwapFit)
mammoth dashboard trash
Move one dashboard to the trash (reversible).
mammoth dashboard trash 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.trash· Result:DashboardTrashResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.trash, APIPOST /dashboards/{dashboard_id}/trash(TrashDashboard)
mammoth dashboard unpublished
Draft changes since the published version.
mammoth dashboard unpublished 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.unpublished· Result:DashboardUnpublishedResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.unpublished, APIGET /dashboards/{dashboard_id}/unpublished(GetUnpublishedChanges)
mammoth dashboard update
Apply a JSON Patch to one dashboard. Dashboard id is positional.
mammoth dashboard update 123 --input '{"patch": [{"op": "replace", "path": "title", "value": "Renamed dashboard"}]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
patch | --input field | yes | — | list[DashboardPatchItem] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: Updates dashboard fields; read the dashboard first (
dashboard get). - Id:
dashboard.update· Result:DashboardUpdateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.update, APIPATCH /dashboards/{dashboard_id}(EditDashboard)
mammoth dashboard video-state
Motion-story video export state (never kicks a render).
mammoth dashboard video-state 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
aspect | --input field | no | — | Literal['landscape', 'square', 'portrait', None] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.video-state· Result:DashboardVideoStateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.video_state, APIGET /dashboards/{dashboard_id}/video-state(GetVideoState)
mammoth dashboard widget-data
Run a widget-data request for a dashboard by id. 'body' from '--input'.
mammoth dashboard widget-data 123 --input '{"body": {"params": {"widgets": [{"widget_id": "00000000-0000-4000-8000-000000000001"}]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.widget-data· Result:DashboardWidgetDataResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.widget_data, APIPOST /dashboards/{dashboard_id}/widgets/data(BulkWidgetData)
mammoth dashboard widget-data-by-url
Run a widget-data request for a dashboard by url. 'body' from '--input'.
mammoth dashboard widget-data-by-url https://example.com/data.csv --input '{"body": {"params": {"widgets": [{"widget_id": "00000000-0000-4000-8000-000000000001"}]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: URL.
- Id:
dashboard.widget-data-by-url· Result:DashboardWidgetDataByUrlResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.widget_data_by_url, APIPOST /dashboards/url/{url}/widgets/data(BulkWidgetDataByUrl)
dashboard audience
mammoth dashboard audience digest get
Get the caller's weekly audience email setting for one board.
mammoth dashboard audience digest get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Your weekly audience email setting for the board: enabled is the effective answer, explicit the stored choice (null when you never chose; the email then turns on by itself above 5 people a week for the creator and directly-granted editors). Editors only.
- Id:
dashboard.audience.digest.get· Result:DashboardAudienceDigestGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.audience_digest_get, APIGET /dashboards/{dashboard_id}/audience/digest(GetAudienceDigest)
mammoth dashboard audience digest set
Store the caller's choice for one board's weekly audience email.
mammoth dashboard audience digest set 123 --input '{"enabled": true}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
enabled | --input field | yes | — | bool |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Writes your own weekly audience email setting for the board, nobody else's. Pass enabled in --input: true, false, or null to clear the choice and return to the default. Editors only.
- Id:
dashboard.audience.digest.set· Result:DashboardAudienceDigestSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.audience_digest_set, APIPUT /dashboards/{dashboard_id}/audience/digest(SetAudienceDigest)
mammoth dashboard audience get
Get who read a board: totals, daily series, viewers, reach and actions.
mammoth dashboard audience get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
days | --input field | no | 7 | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Who read the board over the last days (7, 30 or 90; default 7): totals against the window before, a daily series, named workspace viewers, anonymous counts, country, device and viewport coverage, people it was shared with who never opened it, page and tile reach, and outward actions. Editors only. Never returns an IP or a city; editors' own visits are not counted.
- Id:
dashboard.audience.get· Result:DashboardAudienceGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.audience, APIGET /dashboards/{dashboard_id}/audience(GetDashboardAudience)
mammoth dashboard audience summary
Get views per board for the dashboard library: several boards in one call.
mammoth dashboard audience summary --input '{"dashboard_ids": [1]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
dashboard_ids | --input field | yes | — | list[int] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Views per board for the dashboard library: pass dashboard_ids in --input (200 are read at most). Per board: views and people over 7 days, views over 30 days, the last view and a 14-day daily series. A board never viewed is absent from items; boards outside the workspace or that you cannot edit are ignored.
- Id:
dashboard.audience.summary· Result:DashboardAudienceSummaryResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.audience_summary, APIGET /workspaces/{workspace_id}/dashboards/audience-summary(AudienceSummary)
dashboard canvas
mammoth dashboard canvas get
Get a dashboard's draft canvas, as the editor shows it.
The result leaves out detail you rarely need. Pass --full for all of it.
mammoth dashboard canvas get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
sequence | --input field | no | — | int | |
rls_preview_value | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: A board's data is the view in the canvas dataset.dataview_id: read it with view data get VIEW_ID. After a board's bake job, read the canvas and quote one number from it, such as a KPI total.
- Id:
dashboard.canvas.get· Result:DashboardCanvasGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.canvas_get, APIGET /dashboards/{dashboard_id}/canvas(GetCanvasDraft)
mammoth dashboard canvas restore
Undo, redo or revert the draft canvas to a target version.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard canvas restore 123 --input '{"body": {"params": {"target_sequence": 1}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | RestoreCanvasSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: target_sequence must be an existing draft version -- get the list from dashboard chat history DASHBOARD_ID, whose revisions[] gives {sequence, updated_at, updated_by_name} for every saved version, oldest first; pick the sequence to undo/redo/revert to.
- Id:
dashboard.canvas.restore· Result:DashboardCanvasRestoreResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.canvas_restore, APIPOST /dashboards/{dashboard_id}/canvas/restore(RestoreCanvas)
mammoth dashboard canvas save
Save the draft canvas as a new version.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard canvas save 123 --input '{"body": {"params": {"canvas": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | SaveCanvasSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Read the canvas with dashboard canvas get, edit, write back; a canvas with pages[] bakes the ACTIVE page (pages[i].focus / pages[i].added), a root-level focus is stored but produces no descriptors. focus.kpis entries are {field, agg, label, unit, decimals, filters}; agg countDistinct persists and bakes (ILG simulation 2026-09-19). added[].measure is a column name; a ratio goes in canvas.derived[] as {id, numerator, denominator} and is referenced by id from measure or a KPI field. Validation errors return the pydantic path (e.g. pages.0.added.2.measure). The response carries bake_job_id: job wait it, then dashboard canvas get for meta.figures (figure key -> descriptor id) and dashboard descriptor-data to evaluate. This raw route does not pass the LLM unit guard that pages add / chat edit apply.
- Id:
dashboard.canvas.save· Result:DashboardCanvasSaveResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.canvas_save, APIPUT /dashboards/{dashboard_id}/canvas(SaveCanvas)
dashboard chart-type
mammoth dashboard chart-type create
Save a custom chart as a workspace chart type (owners, admins and members).
mammoth dashboard chart-type create --input '{"body": {"params": {"name": "Lollipop", "recipe": {"version": 1, "layout": "rows", "names": {"field": "region", "position": "before"}, "order": {"field": "sales", "dir": "desc"}, "marks": [{"mark": "segment", "colour": "muted", "size": {"field": "sales"}}, {"mark": "circle", "colour": "primary", "size": {"field": "sales"}}]}, "needs": [{"field": "region", "type": "text", "role": "dim", "label": "Category"}, {"field": "sales", "type": "number", "role": "measure", "label": "Value"}], "binding_template": {"agg": "sum"}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Workspace owners, admins and members. 400 with the reason when the name, needs, recipe or binding template break a rule, or the workspace already keeps 200 chart types.
- Id:
dashboard.chart-type.create· Result:DashboardChartTypeCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chart_type_create, APIPOST /dashboards/v3/chart-types(CreateWorkspaceChartType)
mammoth dashboard chart-type delete
Delete a workspace chart type (workspace owners, admins and members).
mammoth dashboard chart-type delete resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CHART_TYPE_ID | positional | yes | — | str | ID of the chart type. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Workspace owners, admins and members; 404 for a chart type of another workspace.
- Id:
dashboard.chart-type.delete· Result:DashboardChartTypeDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chart_type_delete, APIDELETE /dashboards/v3/chart-types/{chart_type_id}(DeleteWorkspaceChartType)
mammoth dashboard chart-type list
List the workspace's saved chart types, newest first.
mammoth dashboard chart-type list
- Effect: Read, scope
project· Confirmation: none - Preconditions: Anyone in the workspace.
- Id:
dashboard.chart-type.list· Result:DashboardChartTypeListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chart_type_list, APIGET /dashboards/v3/chart-types(ListWorkspaceChartTypes)
dashboard chat
mammoth dashboard chat attachment upload
Attach a local file to a dashboard's editor chat; the result's 'ref' goes in a turn.
mammoth dashboard chat attachment upload 123 notes.pdf
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
FILE | positional | yes | — | str | Path to a local file to attach to the dashboard chat. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, FILE.
- Id:
dashboard.chat.attachment.upload· Result:DashboardChatAttachmentUploadResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chat_attachment_upload, APIPOST /dashboards/{dashboard_id}/chat/attachments(UploadChatAttachment)
mammoth dashboard chat edit
Send one chat message that edits the dashboard.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard chat edit 123 --input '{"body": {"params": {"prompt": "Summarize revenue by region"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | ChatEditSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Changes an existing board from one sentence (add, remove or change a chart, KPI or page): {"body": {"params": {"prompt": "<the change>"}}}; returns changed, a one-line message, the rebaked canvas, dashboard_link and values (the evaluated number of each KPI card and tile after the edit). Use it for a change you can say in a sentence; use dashboard canvas save to author the canvas yourself (units, hiding built-in tiles).
- Id:
dashboard.chat.edit· Result:DashboardChatEditResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chat_edit, APIPOST /dashboards/{dashboard_id}/chat(ChatEdit)
mammoth dashboard chat history
Get a dashboard's editor chat transcript.
mammoth dashboard chat history 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
sequence | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: The response carries a revisions[] list (one {sequence, updated_at, updated_by_name} per saved version, oldest first) -- real on the wire but not yet in the typed SDK model, so read it from --output json. It is the version list for dashboard canvas restore's target_sequence: to undo/revert the board, find the sequence to go back to here and pass it there.
- Id:
dashboard.chat.history· Result:DashboardChatHistoryResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.chat_history, APIGET /dashboards/{dashboard_id}/chat(DashboardV3ChatHistory)
dashboard context
mammoth dashboard context apply
Write the candidate a context review proposed, as a new canvas version.
mammoth dashboard context apply 123 resource-123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
REVIEW_ID | positional | yes | — | str | ID of the review. |
keep | --input field | no | — | list[str] | |
base_sequence | --input field | no | — | int |
- Effect: Benign mutation, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Writes the candidate a dashboard context review proposed, as a new canvas version that undo and the version timeline reach. The change is the server's own reviewed plan, never canvas content from the caller. Pass the review_id from dashboard context review (second positional). Optional keep (roster keys whose hand-typed text to keep) and base_sequence (the head the review was computed against). The server rejects an expired or superseded review, and a board whose head moved since the review.
- Id:
dashboard.context.apply· Result:DashboardContextApplyResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_apply, APIPOST /dashboards/{dashboard_id}/context-review/{review_id}/apply(ApplyContextReview)
mammoth dashboard context create
Create a workspace context that dashboards can apply.
mammoth dashboard context create --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ContextSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.context.create· Result:DashboardContextCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_create, APIPOST /dashboards/v3/contexts(CreateContext)
mammoth dashboard context delete
Delete a workspace context.
mammoth dashboard context delete resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CONTEXT_ID | positional | yes | — | str | ID of the context. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: CONTEXT_ID.
- Id:
dashboard.context.delete· Result:DashboardContextDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_delete, APIDELETE /dashboards/v3/contexts/{context_id}(DeleteContext)
mammoth dashboard context extract
Extract a context file into slot suggestions (release route).
mammoth dashboard context extract --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ContextExtractSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.context.extract· Result:ContextExtractResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.extract_context, APIPOST /dashboards/v3/contexts/extract(ExtractContext)
mammoth dashboard context list
List the workspace's contexts.
mammoth dashboard context list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.context.list· Result:DashboardContextListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_list, APIGET /dashboards/v3/contexts(ListContexts)
mammoth dashboard context review
Dry-run what applying a board's current context would change.
mammoth dashboard context review 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
scope | --input field | no | — | str | |
note | --input field | no | — | str | |
fresh | --input field | no | false | bool |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Dry run of a context edit: what applying the board's current context would change. Nothing is written (not the canvas, the transcript or the bake). Waits for the job; its result holds the item-level change set and a review_id, which is null when the context changes nothing. Optional scope (summary, insights or all), note (1000 characters at most) and fresh (work it out again). Pass review_id to dashboard context apply.
- Id:
dashboard.context.review· Result:DashboardContextReviewResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_review, APIPOST /dashboards/{dashboard_id}/context-review(ReviewContext)
mammoth dashboard context update
Update a workspace context.
mammoth dashboard context update resource-123 --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
CONTEXT_ID | positional | yes | — | str | ID of the context. |
body | --input field | yes | — | ContextSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: CONTEXT_ID.
- Id:
dashboard.context.update· Result:DashboardContextUpdateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.context_update, APIPUT /dashboards/v3/contexts/{context_id}(UpdateContext)
dashboard data
mammoth dashboard data draft
Read one widget's rows from a dashboard's draft state. Fields come from '--input'.
mammoth dashboard data draft 123 --input '{"widget_id": "550e8400-e29b-41d4-a716-446655440000"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
widget_id | --input field | yes | — | str | |
global_filters | --input field | no | — | dict[str, any] | |
drilldown_filters | --input field | no | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.data.draft· Result:DashboardDataDraftResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get_draft_data, APIPOST /dashboards/{dashboard_id}/getDraftData(GetDraftDataFromSql)
mammoth dashboard data published
Read one widget's rows from a dashboard's published state. Fields from '--input'.
mammoth dashboard data published 123 --input '{"widget_id": "550e8400-e29b-41d4-a716-446655440000"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
widget_id | --input field | yes | — | str | |
global_filters | --input field | no | — | dict[str, any] | |
drilldown_filters | --input field | no | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.data.published· Result:DashboardDataPublishedResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get_publish_data, APIPOST /dashboards/{dashboard_id}/getPublishData(GetPublishDataFromSql)
dashboard email-updates
mammoth dashboard email-updates get
A dashboard's email updates.
mammoth dashboard email-updates get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.email-updates.get· Result:DashboardEmailUpdatesGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_get, APIGET /dashboards/{dashboard_id}/email-updates(GetDashboardEmailUpdates)
mammoth dashboard email-updates list
Email updates in this workspace.
mammoth dashboard email-updates list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.email-updates.list· Result:DashboardEmailUpdatesListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_list, APIGET /dashboards/email-updates(ListWorkspaceEmailUpdates)
mammoth dashboard email-updates me get
Whether I get this dashboard's email updates.
mammoth dashboard email-updates me get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.email-updates.me.get· Result:DashboardEmailUpdatesMeGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_me_get, APIGET /dashboards/{dashboard_id}/email-updates/me(GetMyDashboardEmailUpdates)
mammoth dashboard email-updates me set
Turn my email updates for this dashboard back on, or off.
mammoth dashboard email-updates me set 123 --input '{"body": {"subscribed": true}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | EmailUpdateSubscriptionBody |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Turns your own email updates for the dashboard on or off; nobody else's.
- Id:
dashboard.email-updates.me.set· Result:DashboardEmailUpdatesMeSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_me_set, APIPUT /dashboards/{dashboard_id}/email-updates/me(SetMyDashboardEmailUpdates)
mammoth dashboard email-updates set
Turn a dashboard's email updates on, off, or change them.
mammoth dashboard email-updates set 123 --input '{"body": {"enabled": true, "timezone": "UTC"}}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | EmailUpdateSettingsBody |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Saves the email-update schedule and the people who get the dashboard's headline numbers by mail. Needs --yes. Editors only.
- Id:
dashboard.email-updates.set· Result:DashboardEmailUpdatesSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_set, APIPUT /dashboards/{dashboard_id}/email-updates(SaveDashboardEmailUpdates)
mammoth dashboard email-updates test
Send me a test email update.
mammoth dashboard email-updates test 123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Sends a real test email update right away. Needs --yes.
- Id:
dashboard.email-updates.test· Result:DashboardEmailUpdatesTestResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.email_updates_test, APIPOST /dashboards/{dashboard_id}/email-updates/test(TestDashboardEmailUpdate)
dashboard embed
mammoth dashboard embed config get
Read a board's embed settings.
mammoth dashboard embed config get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.config.get· Result:DashboardEmbedConfigGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_config_get, APIGET /dashboards/{dashboard_id}/embed/config(GetEmbedConfig)
mammoth dashboard embed config set
Save a board's embed settings (mode, origin allowlist, appearance).
mammoth dashboard embed config set 123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
mode | --input field | no | — | Literal['key', 'signed'] | One of key, signed. |
allow_any_origin | --input field | no | — | bool | |
allowed_origins | --input field | no | — | list[str] | |
appearance | --input field | no | — | dict[str, any] | |
snippet | --input field | no | — | dict[str, any] |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.config.set· Result:DashboardEmbedConfigSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_config_set, APIPUT /dashboards/{dashboard_id}/embed/config(PutEmbedConfig)
mammoth dashboard embed key rotate
Create or rotate a board's embed key (Basic embeds).
mammoth dashboard embed key rotate 123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
keep_previous | --input field | no | true | bool |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.key.rotate· Result:DashboardEmbedKeyRotateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_key_rotate, APIPOST /dashboards/{dashboard_id}/embed/key(RotateEmbedKey)
mammoth dashboard embed lifetime set
Set how long an embed viewer session lives for a workspace.
mammoth dashboard embed lifetime set 123 --input '{"token_ttl": 900}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
WORKSPACE_ID | positional | yes | — | int | ID of the workspace. |
token_ttl | --input field | yes | — | int |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: WORKSPACE_ID.
- Id:
dashboard.embed.lifetime.set· Result:DashboardEmbedLifetimeSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_lifetime_set, APIPUT /workspaces/{workspace_id}/embed/lifetime(SetEmbedLifetime)
mammoth dashboard embed origin revoke
Remove one origin from a board's embed allowlist.
mammoth dashboard embed origin revoke 123 --input '{"origin": "https://example.com"}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
origin | --input field | yes | — | str |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.origin.revoke· Result:DashboardEmbedOriginRevokeResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_origin_revoke, APIDELETE /dashboards/{dashboard_id}/embed/origin(RevokeOrigin)
mammoth dashboard embed preview-token create
Mint a preview token for the embed simulator (editor-only).
The credential in the result is masked. Pass --reveal to print it; it is shown only once.
mammoth dashboard embed preview-token create 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
claims | --input field | no | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.preview-token.create· Result:DashboardEmbedPreviewTokenCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_preview_token_create, APIPOST /dashboards/{dashboard_id}/embed/preview-token(PreviewToken)
mammoth dashboard embed secret rotate
Create or rotate the workspace's embed signing secret (owners/admins).
The credential in the result is masked. Pass --reveal to print it; it is shown only once.
mammoth dashboard embed secret rotate 123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
WORKSPACE_ID | positional | yes | — | int | ID of the workspace. |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: WORKSPACE_ID.
- Id:
dashboard.embed.secret.rotate· Result:DashboardEmbedSecretRotateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_secret_rotate, APIPOST /workspaces/{workspace_id}/embed/secret(RotateEmbedSecret)
mammoth dashboard embed usage get
Get one board's embed registry: origins, tiles and render counts.
mammoth dashboard embed usage get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.embed.usage.get· Result:DashboardEmbedUsageGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_usage_get, APIGET /dashboards/{dashboard_id}/embed/usage(GetEmbedUsage)
mammoth dashboard embed usage summary
Count the active embed origins of several boards in one call.
mammoth dashboard embed usage summary --input '{"dashboard_ids": [1]}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
dashboard_ids | --input field | yes | — | list[int] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Active embed origins per board over the last 90 days, for several boards in one call (the library view). Boards outside the workspace are ignored. For one board's origins and render counts use dashboard embed usage get.
- Id:
dashboard.embed.usage.summary· Result:DashboardEmbedUsageSummaryResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.embed_usage_summary, APIGET /workspaces/{workspace_id}/dashboards/embed-usage(EmbedUsageSummary)
dashboard engagement
mammoth dashboard engagement get
Show who has opened a dashboard: reach, depth, devices and actions.
mammoth dashboard engagement get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
days | --input field | no | 30 | int | |
viewers | --input field | no | all | str |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. Editors only. Reach against the people the board is shared with, depth per page and per person, hours (UTC), surface, devices, actions and board events. days is 7, 30 or 90 (default 30); viewers is all, named or anonymous.
- Id:
dashboard.engagement.get· Result:DashboardEngagementGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.engagement, APIGET /dashboards/{dashboard_id}/engagement(GetDashboardEngagement)
mammoth dashboard engagement person
Show one person's recent visits to a dashboard. Dashboard id and user id are positional.
mammoth dashboard engagement person 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
USER_ID | positional | yes | — | int | ID of the user. |
days | --input field | no | 30 | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. One person's visits to the board, newest first, at most 50. Take USER_ID from the people list of dashboard engagement get. days is 7, 30 or 90 (default 30).
- Id:
dashboard.engagement.person· Result:DashboardEngagementPersonResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.engagement_person, APIGET /dashboards/{dashboard_id}/engagement/people/{user_id}(GetDashboardEngagementPerson)
mammoth dashboard engagement remind
Email the share link again to people who have not opened a dashboard.
mammoth dashboard engagement remind 123 --input '{"user_ids": [1]}' --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
user_ids | --input field | yes | — | list[int] |
- Effect: External effect, scope
project· Confirmation: always--yes, even at a terminal - Preconditions: Emails the share link again to people who have not opened the board. user_ids takes 1 to 200 people from dashboard engagement get (people with can_remind true). The server sends one reminder per person per board every 7 days; skipped lists who was left out and why. Always needs --yes; --dry-run sends nothing.
- Id:
dashboard.engagement.remind· Result:DashboardEngagementRemindResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.engagement_remind, APIPOST /dashboards/{dashboard_id}/engagement/remind(PostDashboardEngagementRemind)
dashboard exemplar
mammoth dashboard exemplar extract
Extract an example report into an editable dashboard spec.
mammoth dashboard exemplar extract --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ExemplarExtractSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.exemplar.extract· Result:ExemplarExtractResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.extract_exemplar, APIPOST /dashboards/v3/exemplar/extract(ExtractExemplar)
dashboard figure
mammoth dashboard figure add
Add one figure to a dashboard, from an intent or an exact figure spec.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard figure add 123 --input '{"dataview_id": 1, "figure": {"kind": "hbar", "title": "Revenue by region", "dim": "Region", "measure": "Revenue", "agg": "sum"}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
dataview_id | --input field | yes | — | int | |
figure | --input field | yes | — | dict[str, any] | |
banded | --input field | no | — | dict[str, any] | |
intent | --input field | no | — | str | |
kind | --input field | no | — | str | |
page | --input field | no | — | dict[str, any] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Adds one figure (an explore card) with no chat turn. Pass {"intent": "..."} (optional kind) and the server picks and draws the chart, as dashboard figure-intent does; or pass an exact figure. With a figure, dataview_id must be the dashboard's own view. figure is the figure as the canvas stores it, without its id: kind plus its bindings (measure, dim, agg, title). Optional banded (a banded dimension without its id; figure.dim then points at it) and page: {"id": PAGE_ID} for an existing content page or {"new_title": "..."} for a new one; with neither the figure lands on the first content page. The server checks the figure against the dashboard's source and queues the bake: the result carries bake_job_id; wait for it with job wait.
- Id:
dashboard.figure.add· Result:DashboardFigureAddResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.append_figure, APIPOST /dashboards/{dashboard_id}/figures(AppendFigure)
mammoth dashboard figure drill
Drill one mark of a draft board's figure one level down (editors).
mammoth dashboard figure drill 123 --input '{"body": {"params": {"figure": "p1:add:t-Eh6h-ImH", "path": [{"key": "West"}]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Editors of the draft board.
figureis the figure's PAGE:SLOT:ID key (the keys ofmeta.figuresindashboard canvas get);pathholds 1-4 marks from the top level, each{"key": VALUE}. Waits for the job and returns the handle with its results; a figure with no level below answers 400 drill_no_level. - Id:
dashboard.figure.drill· Result:DashboardFigureDrillResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.figure_drill, APIPOST /dashboards/{dashboard_id}/drill(FigureDrill)
mammoth dashboard figure recipe
Turn a described chart into a figure spec: a library chart, or a custom drawing.
mammoth dashboard figure recipe 123 --input '{"body": {"params": {"describe": "Revenue by region as bars"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only: nothing is saved. Add the returned
addedspec withdashboard figure add. A projection is refused: a drawing cannot show a number that is not in the data. - Id:
dashboard.figure.recipe· Result:DashboardFigureRecipeResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.figure_recipe, APIPOST /dashboards/{dashboard_id}/figure-recipe(FigureRecipe)
mammoth dashboard figure rows
Read the records behind one chart mark or KPI card of a draft board (editors).
mammoth dashboard figure rows 123 --input '{"body": {"params": {"figure": "p1:add:t-Eh6h-ImH", "key": "West"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Editors with access to the figure's dataview; works before the figure's reader setting is on.
figureis the PAGE:SLOT:ID key andkeythe mark's value. Waits for the job and returns the handle (which descriptor is the rows, the count and the total) with the results: up to 500 rows. - Id:
dashboard.figure.rows· Result:DashboardFigureRowsResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.figure_rows, APIPOST /dashboards/{dashboard_id}/rows(FigureRows)
dashboard filter
mammoth dashboard filter add
Add (or replace) the filter control on one column of a board.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard filter add 123 --input '{"field": "Status"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
field | --input field | yes | — | str | |
control | --input field | no | — | Literal['multi', 'dropdown', 'chips', 'search', 'range', 'motion'] | One of multi, dropdown, chips, search, range, motion. |
label | --input field | no | — | str | |
default | --input field | no | — | list[str] |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Adds a filter control on one column to ONE board so the viewer picks the value (Region, Month, Status). Use this for any "per <column>" or "by <column>" ask instead of building a board per value. --input: "field" (a column of the board's data, required), optional "control" (multi, dropdown, chips, search for a category; range for a number or date; the backend rejects a control the column type does not take), "label", "default" (list of values selected at first). A second add on the same field replaces the first. Reads the draft canvas, edits filters[], saves it; returns the declared filters, sequence and bake_job_id (dashboard job wait). Example: --input '{"field": "Region", "control": "dropdown", "label": "Region"}'.
- Id:
dashboard.filter.add· Result:DashboardFilterResult
mammoth dashboard filter list
List the filter controls a board declares.
mammoth dashboard filter list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Lists the filter controls a board declares ({field, control, label, default}); read it before adding one.
- Id:
dashboard.filter.list· Result:DashboardFilterResult
mammoth dashboard filter remove
Remove the filter control on one column of a board.
mammoth dashboard filter remove 123 --input '{"field": "Status"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
field | --input field | yes | — | str |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Removes the filter control on one column from a board; fails and names the declared filters when the column has none. --input: {"field": COLUMN}. Returns the filters that remain, sequence and bake_job_id.
- Id:
dashboard.filter.remove· Result:DashboardFilterResult
dashboard gallery
mammoth dashboard gallery get
Get one template card from the public gallery.
mammoth dashboard gallery get revenue-overview
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SLUG | positional | yes | — | str | Template slug. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: One card of the public template gallery. A user-saved template, or a curated one that is not live, answers 404 exactly as an unknown slug does.
- Id:
dashboard.gallery.get· Result:DashboardGalleryGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.gallery_get, APIGET /dashboards/public/templates/{slug}(DashboardPublicTemplate)
mammoth dashboard gallery list
List the public template gallery: curated, live templates only.
mammoth dashboard gallery list
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
function | --input field | no | — | str | |
industry | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: The public template gallery as data: curated, live templates only, with copy, taxonomy labels, thumbnail_ref and viewer_url, and the function/industry facets with counts. No internal ids. Optional function or industry narrow it; an unknown facet answers 404. To use one in this workspace, use dashboard template list and dashboard templates use.
- Id:
dashboard.gallery.list· Result:DashboardGalleryListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.gallery_list, APIGET /dashboards/public/templates(DashboardPublicTemplates)
dashboard live-chart
mammoth dashboard live-chart audience
Change who can see a live chart.
mammoth dashboard live-chart audience 123 --input '{"body": {"params": {"audience": "workspace"}}}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | ChangeAudienceSpec |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Changes who can open the live chart. Pass the new audience in --input. Confirms the dashboard id.
- Id:
dashboard.live-chart.audience· Result:DashboardLiveChartAudienceResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_audience, APIPATCH /dashboards/v3/live-charts/{dashboard_id}(ChangeAudience)
mammoth dashboard live-chart create
Make a chat chart live.
mammoth dashboard live-chart create --input '{"body": {"params": {"view_id": 1, "figure": {}, "title": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | CreateLiveChartSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: starts a job; waits or returns it depending on input - Preconditions: Turns a chart made in an agent chat into a live chart on a dashboard of its own. Creates a dashboard, then waits for its bake job (bounded by --job-timeout) and reads the chart back; making the same chat chart live twice returns the first chart with no job. --project names the project the chart belongs to; without it the server uses the source view's project.
- Id:
dashboard.live-chart.create· Result:DashboardLiveChartCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_create, APIPOST /dashboards/v3/live-charts(CreateLiveChart)
mammoth dashboard live-chart get
Read a live chart.
mammoth dashboard live-chart get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.live-chart.get· Result:DashboardLiveChartGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_get, APIGET /dashboards/v3/live-charts/{dashboard_id}(GetLiveChart)
mammoth dashboard live-chart list
The charts one chat made live.
mammoth dashboard live-chart list resource-123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SESSION_ID | positional | yes | — | str | ID of the session. |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: SESSION_ID.
- Id:
dashboard.live-chart.list· Result:DashboardLiveChartListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_list, APIGET /dashboards/v3/live-charts(ListLiveCharts)
mammoth dashboard live-chart placement
Record a dashboard the chart was added to.
mammoth dashboard live-chart placement 123 --input '{"body": {"params": {"dashboard_id": 1, "figure_id": "resource-123"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | RecordPlacementSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Records where a live chart is shown (an embed or a page).
- Id:
dashboard.live-chart.placement· Result:DashboardLiveChartPlacementResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_placement, APIPOST /dashboards/v3/live-charts/{dashboard_id}/placements(RecordPlacement)
mammoth dashboard live-chart usage
Where a live chart is used.
mammoth dashboard live-chart usage 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.live-chart.usage· Result:DashboardLiveChartUsageResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.live_chart_usage, APIGET /dashboards/v3/live-charts/{dashboard_id}/usage(GetUsage)
dashboard own-data
mammoth dashboard own-data accept
Apply the proposed 'use my data' version to a board; this changes it.
mammoth dashboard own-data accept 123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
choice | --input field | no | proposal | str | |
exclude | --input field | no | — | list[str] |
- Effect: Benign mutation, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Applies the proposed version to the board, which changes it. choice is proposal (default), partial or reshape; exclude lists change ids of added items to leave out. Waits for the applying job.
- Id:
dashboard.own-data.accept· Result:DashboardOwnDataAcceptResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.own_data_accept, APIPOST /dashboards/v3/{dashboard_id}/own-data/accept(AcceptOwnData)
mammoth dashboard own-data dismiss
Drop a board's pending 'use my data' run; the board is not changed.
mammoth dashboard own-data dismiss 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Drops the pending 'use my data' run. The board is not changed.
- Id:
dashboard.own-data.dismiss· Result:DashboardOwnDataDismissResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.own_data_dismiss, APIPOST /dashboards/v3/{dashboard_id}/own-data/dismiss(DismissOwnData)
mammoth dashboard own-data preview
Preview a board on your own data as proposed, without saving it.
mammoth dashboard own-data preview 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. The adapted board as proposed, baked but not saved.
- Id:
dashboard.own-data.preview· Result:DashboardOwnDataPreviewResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.own_data_preview, APIGET /dashboards/v3/{dashboard_id}/own-data/preview(PreviewOwnData)
mammoth dashboard own-data start
Fit a template board to your own data and wait for the proposal.
mammoth dashboard own-data start 123 --input '{"dataview_id": 1}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
ingest_job_id | --input field | no | — | int | |
dataset_id | --input field | no | — | int | |
dataview_id | --input field | no | — | int | |
file_name | --input field | no | — | str |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Fits a template board to your own data and waits for the proposal. Give exactly one of dataview_id, dataset_id or ingest_job_id. The board is not changed; read the proposal with dashboard own-data status and preview, then accept or dismiss. Replaces any pending run. Uses an AI call.
- Id:
dashboard.own-data.start· Result:DashboardOwnDataStartResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.own_data_start, APIPOST /dashboards/v3/{dashboard_id}/own-data(StartOwnData)
mammoth dashboard own-data status
Show a board's pending 'use my data' run; status null means none.
mammoth dashboard own-data status 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Read-only. The board's pending 'use my data' run: status and stage, and once fitted the proposal. status null means nothing is pending.
- Id:
dashboard.own-data.status· Result:DashboardOwnDataStatusResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.own_data_status, APIGET /dashboards/v3/{dashboard_id}/own-data(GetOwnData)
dashboard page
mammoth dashboard page plan
Compose a new page from an intent.
mammoth dashboard page plan 123 --input '{"body": {"params": {"intent": "Summarize revenue by region"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | PlanPageSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.page.plan· Result:DashboardPagePlanResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.page_plan, APIPOST /dashboards/{dashboard_id}/plan-page(PlanPage)
dashboard pages
mammoth dashboard pages add
Append structural pages and start the asynchronous dashboard bake.
mammoth dashboard pages add 123 --input '{"body": {"params": {"pages": [{"title": "By region", "focus": {"measure": "Revenue", "dim": "Region", "kpis": [{"field": "Revenue", "agg": "sum", "label": "Revenue"}]}, "charts": [{"kind": "hbar", "title": "Revenue by region", "dim": "Region", "measure": "Revenue", "agg": "sum"}]}]}}}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | AddPagesSpec |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: returns a job id at once; follow it withmammoth job wait - Preconditions: To add or change content by description, use dashboard chat edit instead. Requires --yes --confirm DASHBOARD_ID. body.params.pages is a list of PageAdd objects: {title, focus: {measure, dim, kpis: [...]}, charts: [{kind, title, dim, measure, agg}]}; the schema example''s {} entry is not a usable page. The route runs through the LLM control guard: in the ILG simulation it dropped unit.prefix on a money card ("nothing in this data says which currency") that dashboard canvas save had kept, and reports that in data.message.
- Id:
dashboard.pages.add· Result:DashboardPagesAddResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.add_pages, APIPOST /dashboards/{dashboard_id}/pages(AddPages)
dashboard pdf
mammoth dashboard pdf export
Kick a draft-dashboard PDF export.
mammoth dashboard pdf export 123 --input '{"body": {"params": {"data": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | PdfExportSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Backend requires params.data to be the browser-hydrated DashboardData map (pre-rendered widget results); the server stores only query descriptors and cannot rebuild it, so a PDF cannot be produced from the CLI alone; point the user to the board's Download PDF in the app.
- Id:
dashboard.pdf.export· Result:DashboardPdfExportResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.pdf_export, APIPOST /dashboards/{dashboard_id}/pdf(ExportPdf)
dashboard published
mammoth dashboard published canvas
Get a published dashboard's viewer canvas.
mammoth dashboard published canvas https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL.
- Id:
dashboard.published.canvas· Result:DashboardPublishedCanvasResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_canvas, APIGET /dashboards/url/{url}/canvas(GetCanvasPublished)
mammoth dashboard published data
Descriptor data for a published dashboard.
mammoth dashboard published data https://example.com/data.csv --input '{"body": {"params": {"descriptor_ids": ["resource-123"]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | DescriptorDataSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: URL.
- Id:
dashboard.published.data· Result:DashboardPublishedDataResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_data, APIPOST /dashboards/url/{url}/data(DescriptorDataByUrl)
mammoth dashboard published drill
Drill one mark of a published board's figure one level down (any viewer).
mammoth dashboard published drill https://example.com/data.csv --input '{"body": {"params": {"figure": "p1:add:t-Eh6h-ImH", "path": [{"key": "West"}]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Any viewer of the published board, under the viewer's row-level scope; 403 drill_disabled until the figure's reader setting lets readers drill. Same body as
dashboard figure drill. - Id:
dashboard.published.drill· Result:DashboardPublishedDrillResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_drill, APIPOST /dashboards/url/{url}/drill(FigureDrillByUrl)
mammoth dashboard published og-card
Published dashboard's link-unfurl OG card (baked PNG).
mammoth dashboard published og-card https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL.
- Id:
dashboard.published.og-card· Result:DashboardPublishedOgCardResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_og_card, APIGET /dashboards/url/{url}/og-card(OgCardByUrl)
mammoth dashboard published pdf export
Kick a published-dashboard PDF export.
mammoth dashboard published pdf export https://example.com/data.csv --input '{"body": {"params": {"data": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | PdfExportSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: URL.
- Id:
dashboard.published.pdf.export· Result:DashboardPublishedPdfExportResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_pdf_export, APIPOST /dashboards/url/{url}/pdf(ExportPdfByUrl)
mammoth dashboard published pdf-artifact
Download a completed published PDF export.
mammoth dashboard published pdf-artifact https://example.com/data.csv 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
JOB_ID | positional | yes | — | int | ID of the job. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL, JOB_ID.
- Id:
dashboard.published.pdf-artifact· Result:DashboardPublishedPdfArtifactResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_pdf_artifact, APIGET /dashboards/url/{url}/pdf/{job_id}(GetPdfArtifactByUrl)
mammoth dashboard published rows
Read the records behind a mark of a published board (signed-in readers).
mammoth dashboard published rows https://example.com/data.csv --input '{"body": {"params": {"figure": "p1:add:t-Eh6h-ImH", "key": "West"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
body | --input field | yes | — | dict[str, any] |
- Effect: Read, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Signed-in readers only, under their row-level scope; 403 rows_disabled until the figure's reader setting is on, and refused on public links and signed embeds. Same body as
dashboard figure rows. - Id:
dashboard.published.rows· Result:DashboardPublishedRowsResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_rows, APIPOST /dashboards/url/{url}/rows(FigureRowsByUrl)
mammoth dashboard published share-page
Published dashboard's link-unfurl share page (crawler-facing HTML).
mammoth dashboard published share-page https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL.
- Id:
dashboard.published.share-page· Result:DashboardPublishedSharePageResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_share_page, APIGET /dashboards/url/{url}/share(SharePageByUrl)
mammoth dashboard published video export
Kick a motion-story video export (published view).
mammoth dashboard published video export https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
aspect | --input field | no | — | Literal['landscape', 'square', 'portrait', None] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: URL.
- Id:
dashboard.published.video.export· Result:DashboardPublishedVideoExportResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_video_export, APIPOST /dashboards/url/{url}/video(ExportVideoByUrl)
mammoth dashboard published video-artifact
Stream a published motion-story video (Range-enabled).
mammoth dashboard published video-artifact https://example.com/data.csv
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
URL | positional | yes | — | str | URL slug identifying the resource. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: URL.
- Id:
dashboard.published.video-artifact· Result:DashboardPublishedVideoArtifactResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.published_video_artifact, APIGET /dashboards/url/{url}/video.mp4(VideoByUrl)
dashboard qa
mammoth dashboard qa ask
Ask one question in a Q&A session; the answer arrives asynchronously.
mammoth dashboard qa ask 123 456 --input '{"body": {"params": {"question": "Summarize revenue by region"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
body | --input field | yes | — | AskSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.ask· Result:DashboardQaAskResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_ask, APIPOST /dashboards/{dashboard_id}/qa/sessions/{session_id}/ask(Ask)
mammoth dashboard qa comment create
Comment on a shared Q&A session.
mammoth dashboard qa comment create 123 456 --input '{"body": {"params": {"body": "Quarterly revenue summary"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
body | --input field | yes | — | CommentSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.comment.create· Result:DashboardQaCommentCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_comment_create, APIPOST /dashboards/{dashboard_id}/qa/sessions/{session_id}/comments(DashboardV3AddComment)
mammoth dashboard qa comment delete
Delete a comment (author or session owner).
mammoth dashboard qa comment delete 123 456 789 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
COMMENT_ID | positional | yes | — | int | ID of the comment. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID, COMMENT_ID.
- Id:
dashboard.qa.comment.delete· Result:DashboardQaCommentDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_comment_delete, APIDELETE /dashboards/{dashboard_id}/qa/sessions/{session_id}/comments/{comment_id}(DeleteComment)
mammoth dashboard qa feedback
Rate an assistant answer (up/down; null clears).
mammoth dashboard qa feedback 123 456 789 --input '{"body": {"params": {"rating": "up"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
MESSAGE_ID | positional | yes | — | int | ID of the message. |
body | --input field | yes | — | FeedbackSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID, MESSAGE_ID.
- Id:
dashboard.qa.feedback· Result:DashboardQaFeedbackResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_feedback, APIPOST /dashboards/{dashboard_id}/qa/sessions/{session_id}/messages/{message_id}/feedback(DashboardV3QaFeedback)
mammoth dashboard qa insights
Get the questions viewers asked on a board, grouped by their text.
mammoth dashboard qa insights 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
days | --input field | no | 7 | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: The questions viewers asked on the board over the last days (7, 30 or 90; default 7), grouped by their text, with feedback and unanswered counts and the measure and dimension each answer was about. Editors only. Nobody is named: no user, session or name is returned, and editors' own questions are left out.
- Id:
dashboard.qa.insights· Result:DashboardQaInsightsResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_insights, APIGET /dashboards/{dashboard_id}/qa/insights(DashboardV3QaInsights)
mammoth dashboard qa session create
Create a Q&A session.
mammoth dashboard qa session create 123 --input '{"body": {"params": {"title": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | CreateSessionSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.qa.session.create· Result:DashboardQaSessionCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_create, APIPOST /dashboards/{dashboard_id}/qa/sessions(CreateSession)
mammoth dashboard qa session delete
Delete a Q&A session (owner only).
mammoth dashboard qa session delete 123 456 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.session.delete· Result:DashboardQaSessionDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_delete, APIDELETE /dashboards/{dashboard_id}/qa/sessions/{session_id}(DashboardV3DeleteSession)
mammoth dashboard qa session fork
Fork a shared Q&A session into a private copy.
mammoth dashboard qa session fork 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.session.fork· Result:DashboardQaSessionForkResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_fork, APIPOST /dashboards/{dashboard_id}/qa/sessions/{session_id}/fork(ForkSession)
mammoth dashboard qa session get
Read a Q&A session (replayable — carries baked answers).
mammoth dashboard qa session get 123 456
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.session.get· Result:DashboardQaSessionGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_get, APIGET /dashboards/{dashboard_id}/qa/sessions/{session_id}(GetSession)
mammoth dashboard qa session list
List Q&A sessions.
mammoth dashboard qa session list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.qa.session.list· Result:DashboardQaSessionListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_list, APIGET /dashboards/{dashboard_id}/qa/sessions(DashboardV3ListSessions)
mammoth dashboard qa session rename
Rename a Q&A session (owner only).
mammoth dashboard qa session rename 123 456 --input '{"body": {"params": {"title": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
body | --input field | yes | — | RenameSessionSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.session.rename· Result:DashboardQaSessionRenameResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_rename, APIPUT /dashboards/{dashboard_id}/qa/sessions/{session_id}/title(RenameSession)
mammoth dashboard qa session set-visibility
Share/unshare a Q&A session (owner only).
mammoth dashboard qa session set-visibility 123 456 --input '{"body": {"params": {"visibility": "shared"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
SESSION_ID | positional | yes | — | int | ID of the session. |
body | --input field | yes | — | VisibilitySpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID, SESSION_ID.
- Id:
dashboard.qa.session.set-visibility· Result:DashboardQaSessionSetVisibilityResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_session_set_visibility, APIPUT /dashboards/{dashboard_id}/qa/sessions/{session_id}/visibility(DashboardV3SetVisibility)
mammoth dashboard qa settings get
Get this dashboard's Q&A settings.
mammoth dashboard qa settings get 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.qa.settings.get· Result:DashboardQaSettingsGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_settings_get, APIGET /dashboards/{dashboard_id}/qa/settings(DashboardV3GetQaSettings)
mammoth dashboard qa settings set
Update this dashboard's Q&A settings (editors only).
mammoth dashboard qa settings set 123 --input '{"body": {"params": {"allow_viewer_qa": true}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | QaSettingsSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.qa.settings.set· Result:DashboardQaSettingsSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.qa_settings_set, APIPUT /dashboards/{dashboard_id}/qa/settings(DashboardV3SetQaSettings)
dashboard rls
mammoth dashboard rls assignment list
List RLS viewer assignments.
mammoth dashboard rls assignment list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.rls.assignment.list· Result:DashboardRlsAssignmentListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.rls_assignment_list, APIGET /dashboards/{dashboard_id}/rls/assignments(ListRlsAssignments)
mammoth dashboard rls assignment set
Replace RLS viewer assignments.
mammoth dashboard rls assignment set 123 --input '{"body": {"params": {"assignments": [{"email": "analyst@example.com"}]}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
body | --input field | yes | — | RlsAssignmentsSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.rls.assignment.set· Result:DashboardRlsAssignmentSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.rls_assignment_set, APIPUT /dashboards/{dashboard_id}/rls/assignments(SetRlsAssignments)
mammoth dashboard rls column list
Candidate columns for the RLS filter.
mammoth dashboard rls column list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.rls.column.list· Result:DashboardRlsColumnListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.rls_column_list, APIGET /dashboards/{dashboard_id}/rls/columns(GetRlsColumns)
mammoth dashboard rls value list
Distinct values for an RLS filter column.
mammoth dashboard rls value list 123 --input '{"column": "Status"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
column | --input field | yes | — | str | |
search | --input field | no | — | str |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.rls.value.list· Result:DashboardRlsValueListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.rls_value_list, APIGET /dashboards/{dashboard_id}/rls/values(GetRlsDistinctValues)
dashboard signature
mammoth dashboard signature create
Create a workspace signature.
mammoth dashboard signature create --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | SignatureSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.signature.create· Result:DashboardSignatureCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.signature_create, APIPOST /dashboards/v3/signatures(CreateSignature)
mammoth dashboard signature delete
Delete a signature.
mammoth dashboard signature delete resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SIGNATURE_ID | positional | yes | — | str | ID of the signature. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: SIGNATURE_ID.
- Id:
dashboard.signature.delete· Result:DashboardSignatureDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.signature_delete, APIDELETE /dashboards/v3/signatures/{signature_id}(DeleteSignature)
mammoth dashboard signature list
List the workspace's signatures.
mammoth dashboard signature list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.signature.list· Result:DashboardSignatureListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.signature_list, APIGET /dashboards/v3/signatures(ListSignatures)
mammoth dashboard signature update
Update a signature.
mammoth dashboard signature update resource-123 --input '{"body": {"params": {"name": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SIGNATURE_ID | positional | yes | — | str | ID of the signature. |
body | --input field | yes | — | SignatureSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: SIGNATURE_ID.
- Id:
dashboard.signature.update· Result:DashboardSignatureUpdateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.signature_update, APIPUT /dashboards/v3/signatures/{signature_id}(UpdateSignature)
dashboard source
mammoth dashboard source list
List dashboard sources available in the active workspace.
mammoth dashboard source list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Some servers answer this with HTTP 500.
- Id:
dashboard.source.list· Result:DashboardSourceListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.get_sources, APIGET /dashboards/sources(GetDashboardSources)
dashboard style
mammoth dashboard style custom create
Create a workspace custom style.
mammoth dashboard style custom create --input '{"body": {"params": {"signals": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | CustomStyleSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.style.custom.create· Result:DashboardStyleCustomCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_custom_create, APIPOST /dashboards/v3/styles/custom(CreateCustomStyle)
mammoth dashboard style custom delete
Delete a custom style.
mammoth dashboard style custom delete resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
STYLE_ID | positional | yes | — | str | ID of the style. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: STYLE_ID.
- Id:
dashboard.style.custom.delete· Result:DashboardStyleCustomDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_custom_delete, APIDELETE /dashboards/v3/styles/custom/{style_id}(DeleteCustomStyle)
mammoth dashboard style custom list
List the workspace's custom styles.
mammoth dashboard style custom list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.style.custom.list· Result:DashboardStyleCustomListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_custom_list, APIGET /dashboards/v3/styles/custom(ListCustomStyles)
mammoth dashboard style custom update
Update a custom style.
mammoth dashboard style custom update resource-123 --input '{"body": {"params": {"signals": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
STYLE_ID | positional | yes | — | str | ID of the style. |
body | --input field | yes | — | CustomStyleSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: STYLE_ID.
- Id:
dashboard.style.custom.update· Result:DashboardStyleCustomUpdateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_custom_update, APIPUT /dashboards/v3/styles/custom/{style_id}(UpdateCustomStyle)
mammoth dashboard style default get
Get the workspace's default style id.
mammoth dashboard style default get
- Effect: Read, scope
project· Confirmation: none - Id:
dashboard.style.default.get· Result:DashboardStyleDefaultGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_default_get, APIGET /dashboards/v3/styles/default(GetDefaultStyle)
mammoth dashboard style default set
Set the workspace default style id.
mammoth dashboard style default set --input '{"body": {"params": {"styleId": "default"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | DefaultStyleSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.style.default.set· Result:DashboardStyleDefaultSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_default_set, APIPUT /dashboards/v3/styles/default(SetDefaultStyle)
mammoth dashboard style derive
Derive a full Style bundle from signals.
mammoth dashboard style derive --input '{"body": {"params": {"signals": {}}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | DeriveStyleSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.style.derive· Result:DashboardStyleDeriveResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_derive, APIPOST /dashboards/v3/styles/derive(DeriveStyle)
mammoth dashboard style extract-brand
Kick a brand extraction from a URL.
mammoth dashboard style extract-brand --input '{"body": {"params": {"url": "https://example.com/data.csv"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ExtractBrandSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Id:
dashboard.style.extract-brand· Result:DashboardStyleExtractBrandResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_extract_brand, APIPOST /dashboards/v3/styles/extract-brand(ExtractBrand)
mammoth dashboard style preset list
Style presets (stock + custom).
mammoth dashboard style preset list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.style.preset.list· Result:DashboardStylePresetListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_preset_list, APIGET /dashboards/v3/styles/presets(ListStylePresets)
mammoth dashboard style token list
Get a full style bundle by id (stock or custom).
mammoth dashboard style token list resource-123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
ID | positional | yes | — | str | Identifier of the resource. |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: ID.
- Id:
dashboard.style.token.list· Result:DashboardStyleTokenListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.style_token_list, APIGET /dashboards/v3/styles/tokens(GetStyleTokens)
dashboard suggestion
mammoth dashboard suggestion list
Data-grounded starting points for the create screen.
mammoth dashboard suggestion list 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
table_item_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
dashboard.suggestion.list· Result:DashboardSuggestionListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.suggestion_list, APIGET /dashboards/v3/suggestions(DashboardSuggestions)
dashboard tags
mammoth dashboard tags delete
Delete a workspace dashboard tag after exact-target confirmation.
mammoth dashboard tags delete 123 --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TAG_ID | positional | yes | — | int | ID of the tag. |
- Effect: Destructive, scope
workspace· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: TAG_ID.
- Id:
dashboard.tags.delete· Result:DashboardTagsDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.delete_tag, APIDELETE /dashboards/tags/{tag_id}(DeleteDashboardTag)
mammoth dashboard tags list
List the workspace dashboard-tag vocabulary.
mammoth dashboard tags list
- Effect: Read, scope
workspace· Confirmation: none - Id:
dashboard.tags.list· Result:DashboardTagsListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.list_tags, APIGET /dashboards/tags(ListDashboardTags)
mammoth dashboard tags merge
Merge a source workspace dashboard tag into a target tag.
mammoth dashboard tags merge 123 --input '{"target_id": 456}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TAG_ID | positional | yes | — | int | ID of the source tag. |
target_id | --input field | yes | — | int |
- Effect: Destructive, scope
workspace· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: TAG_ID.
- Id:
dashboard.tags.merge· Result:DashboardTagsMergeResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.merge_tag, APIPOST /dashboards/tags/{tag_id}/merge(MergeDashboardTags)
mammoth dashboard tags rename
Rename a dashboard tag. A rename is undone by renaming back, so it asks nothing.
mammoth dashboard tags rename 123 --input '{"name": "Revenue"}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TAG_ID | positional | yes | — | int | ID of the tag. |
name | --input field | yes | — | str |
- Effect: Benign mutation, scope
workspace· Confirmation: none - Preconditions: Required inputs: TAG_ID.
- Id:
dashboard.tags.rename· Result:DashboardTagsRenameResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.rename_tag, APIPATCH /dashboards/tags/{tag_id}(RenameDashboardTag)
mammoth dashboard tags set
Replace all dashboard tags after exact-target confirmation.
mammoth dashboard tags set 123 --input '{"tags": ["Revenue"]}' --yes --confirm 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
tags | --input field | yes | — | list[str] |
- Effect: High impact, scope
workspace· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.tags.set· Result:DashboardTagsSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.set_tags, APIPUT /dashboards/{dashboard_id}/tags(SetDashboardTags)
dashboard template
mammoth dashboard template apply
Apply a template to a target dataset.
mammoth dashboard template apply --input '{"body": {"params": {"source_dashboard_id": 1, "target_dataview_id": 1}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ApplyTemplateSpec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Id:
dashboard.template.apply· Result:DashboardTemplateApplyResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_apply, APIPOST /dashboards/v3/templates/apply(ApplyTemplate)
mammoth dashboard template create
Save a dashboard as a workspace template.
mammoth dashboard template create --input '{"body": {"params": {"dashboard_id": 1, "title": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | SaveTemplateSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: dashboard_id must name a dashboard whose widgets bind dataset columns; a blank dashboard fails with "None of the columns this template binds are in the dataset". Build the dashboard first (dashboard create, then widgets), then save it as a template.
- Id:
dashboard.template.create· Result:DashboardTemplateCreateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_create, APIPOST /dashboards/v3/templates(SaveTemplate)
mammoth dashboard template delete
Delete a saved workspace template.
mammoth dashboard template delete resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Required inputs: TEMPLATE_ID.
- Id:
dashboard.template.delete· Result:DashboardTemplateDeleteResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_delete, APIDELETE /dashboards/v3/templates/{template_id}(DashboardV3DeleteTemplate)
mammoth dashboard template fit
Fit-score the whole catalog against one dataset.
mammoth dashboard template fit 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DATAVIEW_ID | positional | yes | — | int | ID of the dataview. |
table_item_id | --input field | no | — | int |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: DATAVIEW_ID.
- Id:
dashboard.template.fit· Result:DashboardTemplateFitResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_fit, APIGET /dashboards/v3/templates/fit(FitTemplates)
mammoth dashboard template get
One template's metadata + self-fit recipe.
mammoth dashboard template get resource-123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: Required inputs: TEMPLATE_ID.
- Id:
dashboard.template.get· Result:DashboardTemplateGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_get, APIGET /dashboards/v3/templates/{template_id}(DashboardV3GetTemplate)
mammoth dashboard template list
Curated template catalog.
mammoth dashboard template list
- Effect: Read, scope
project· Confirmation: none · Pages:single_page - Id:
dashboard.template.list· Result:DashboardTemplateListResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_list, APIGET /dashboards/v3/templates(DashboardV3ListTemplates)
mammoth dashboard template preview
Preview a template mapping applied to a target dataset.
mammoth dashboard template preview --input '{"body": {"params": {"source_dashboard_id": 1}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | PreviewTemplateSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.template.preview· Result:DashboardTemplatePreviewResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_preview, APIPOST /dashboards/v3/templates/preview(PreviewTemplate)
mammoth dashboard template rename
Rename a saved workspace template.
mammoth dashboard template rename resource-123 --input '{"body": {"params": {"title": "Revenue report"}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
body | --input field | yes | — | RenameTemplateSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Required inputs: TEMPLATE_ID.
- Id:
dashboard.template.rename· Result:DashboardTemplateRenameResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_rename, APIPATCH /dashboards/v3/templates/{template_id}(RenameTemplate)
mammoth dashboard template resolve-mapping
Propose a template mapping onto a target dataset.
mammoth dashboard template resolve-mapping --input '{"body": {"params": {"source_dashboard_id": 1}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | ResolveTemplateMappingSpec |
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.template.resolve-mapping· Result:DashboardTemplateResolveMappingResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_resolve_mapping, APIPOST /dashboards/v3/templates/resolve-mapping(ResolveTemplateMapping)
mammoth dashboard template thumbnail clear
Remove a saved template's picture; its card falls back to the og-card.
mammoth dashboard template thumbnail clear resource-123 --yes
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
- Effect: Destructive, scope
project· Confirmation:--yes, or answer the prompt at an interactive terminal - Preconditions: Removes a saved template's picture (owner or workspace admin); its card falls back to the og-card. ok is false when there was no picture.
- Id:
dashboard.template.thumbnail.clear· Result:DashboardTemplateThumbnailClearResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_thumbnail_clear, APIDELETE /dashboards/v3/templates/{slug}/thumbnail(DashboardV3DeleteTemplateThumbnail)
mammoth dashboard template thumbnail get
Download the picture a template's card shows.
mammoth dashboard template thumbnail get resource-123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
- Effect: Read, scope
project· Confirmation: none - Preconditions: The picture a template's card shows, as content_type and content_base64. A template with no picture answers 404; that is an ordinary state and its card falls back to the og-card.
- Id:
dashboard.template.thumbnail.get· Result:DashboardTemplateThumbnailGetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_thumbnail_get, APIGET /dashboards/v3/templates/{slug}/thumbnail(DashboardV3TemplateThumbnail)
mammoth dashboard template thumbnail set
Replace the picture of a saved workspace template.
mammoth dashboard template thumbnail set resource-123 card.png
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
TEMPLATE_ID | positional | yes | — | str | ID of the template. |
FILE | positional | yes | — | str | Path to a local PNG, JPEG or WebP image (1 MB at most). |
- Effect: Benign mutation, scope
project· Confirmation: none - Preconditions: Replaces the picture of a SAVED workspace template (owner or workspace admin; curated templates are not writable). PNG, JPEG or WebP read from the file's content, 1 MB at most. The file comes from the local disk.
- Id:
dashboard.template.thumbnail.set· Result:DashboardTemplateThumbnailSetResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.template_thumbnail_set, APIPUT /dashboards/v3/templates/{slug}/thumbnail(DashboardV3PutTemplateThumbnail)
dashboard templates
mammoth dashboard templates pending
Claim the pending dashboard template for the workspace.
mammoth dashboard templates pending
- Effect: Benign mutation, scope
project· Confirmation: none - Id:
dashboard.templates.pending· Result:PendingTemplateResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.take_pending_template, APIPOST /dashboards/v3/templates/pending(DashboardV3TakePendingTemplate)
mammoth dashboard templates use
Instantiate a dashboard template on its sample data.
mammoth dashboard templates use revenue-overview --input '{"body": {"params": {"project_id": 1}}}' --yes --confirm revenue-overview
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
SLUG | positional | yes | — | str | Template slug. |
body | --input field | yes | — | UseTemplateSpec |
- Effect: High impact, scope
project· Confirmation: always--yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; theconfirmation_requirederror's hint names it) · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: SLUG.
- Id:
dashboard.templates.use· Result:ObjectJobSchema | JobResponse· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.use_template, APIPOST /dashboards/v3/templates/{slug}/use(UseTemplate)
dashboard v3
mammoth dashboard v3 generate
Generate a v3 dashboard.
The result is compact: ids, checks, verify and a canvas summary. Pass --full for the complete response.
mammoth dashboard v3 generate --input '{"body": {"params": {"intent": "Weekly sales by region", "dataview_id": 1}}}'
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
body | --input field | yes | — | GenerateDashboardV3Spec |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: This is how to make a dashboard: it builds and bakes a whole board from one sentence on one view. Input {"body": {"params": {"intent": "<what the board should show>", "dataview_id": VIEW_ID, "title": "<optional name>"}}}; waits (about 30 s) and returns the baked canvas, plus dashboard_link and values: the evaluated number of every KPI card and tile (one descriptor-data read of the baked board), so compare them with what you saw in the data before you report. Change it afterwards with dashboard chat edit. dashboard create-blank is only for authoring a canvas by hand.
- Id:
dashboard.v3.generate· Result:DashboardV3GenerateResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.v3_generate, APIPOST /dashboards/v3/generate(GenerateDashboardV3)
dashboard video
mammoth dashboard video export
Kick a motion-story video export.
mammoth dashboard video export 123
| Name | Passed as | Required | Default | Type | Notes |
|---|---|---|---|---|---|
DASHBOARD_ID | positional | yes | — | int | ID of the dashboard. |
aspect | --input field | no | — | Literal['landscape', 'square', 'portrait', None] |
- Effect: Benign mutation, scope
project· Confirmation: none · Waits: waits for the job to finish (--job-timeout,--return-running) - Preconditions: Required inputs: DASHBOARD_ID.
- Id:
dashboard.video.export· Result:DashboardVideoExportResult· Backed by: SDKmammoth.api.dashboards.DashboardsAPI.video_export, APIPOST /dashboards/{dashboard_id}/video(ExportVideo)