Topolo Docs Topolo Platform
Open workspace

List Insights dashboards

Read saved dashboard configuration and ordered widgets in the selected workspace.

Outcome

Read saved dashboard configuration and ordered widgets in the selected workspace.

Before you start

  • Verify the exact identity, environment and approved organization with topolo whoami before discovering this action.
  • Inspect the credential-scoped action and canonical resource discovery. Examples use synthetic resources; replace their handles only with separately verified targets.
  • Validate the complete input and review the action plan. Mutation and organization-inventory actions require explicit confirmation; a successful shape check does not prove a runtime grant.
  • Select a granted workspace through topolo resources. The CLI/MCP supplies canonical resource headers; workspace identity is not an arbitrary payload field.

Discover the target

topolo whoami --json
topolo apps get topolo-insights --json
topolo actions get app_topolo_insights.dashboards.list --detail --json
topolo resources topolo-insights --json

Request

GET /api/dashboards · permission workspace:read · read without mutation confirmation.

Inspect schemas and test this action in the signed action console. The complete field schema is also available through CLI/MCP action discovery.

Effects and scope

  • Returns a complete unpaginated scoped array of saved configuration, not rendered analytics results.
  • Widgets include id, kind, title, size and position. SourceKey can be null; description can be null. Window is 7, 30 or 90 days.

Interpret the response

  • Discover data[].id for update/delete and retain the complete original configuration before replacement.
  • Use analytics.overview separately to read data; a saved dashboard record does not prove populated chart results.

Worked requests and responses

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested. Successful and refused captures below are separate examples. A refused response is a boundary, not a successful task.

empty · success 1 · HTTP 200

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested. Selected synthetic workspace: ws_insights_empty. Fixture handles authorize no live request.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions plan app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions call app_topolo_insights.dashboards.list --data @payload.json --detail --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_insights.dashboards.list",
    "input": {}
  }
}

Captured raw Worker result

{
  "data": []
}

HTTP 200. Discover data[].id for update/delete and retain the complete original configuration before replacement. Use analytics.overview separately to read data; a saved dashboard record does not prove populated chart results.

CLI/MCP adds its transport envelope; CLI --detail retains the full action result.

workflow · success 2 · HTTP 200

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested. Selected synthetic workspace: ws_insights_workflow. Fixture handles authorize no live request.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions plan app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions call app_topolo_insights.dashboards.list --data @payload.json --detail --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_insights.dashboards.list",
    "input": {}
  }
}

Captured raw Worker result

{
  "data": [
    {
      "id": "480d495c-5aa2-4ebe-84fa-6a21e7a276e2",
      "name": "Traffic overview",
      "description": null,
      "windowDays": 30,
      "sourceKey": "marketing-site",
      "widgets": [
        {
          "id": "3b0892bf-cc85-449c-95eb-f820c3847e8b",
          "kind": "metric-strip",
          "title": "Metrics",
          "size": "full",
          "position": 0
        }
      ],
      "createdAt": "2026-10-04T08:52:48.420Z",
      "updatedAt": "2026-10-04T08:52:48.420Z"
    }
  ]
}

HTTP 200. Discover data[].id for update/delete and retain the complete original configuration before replacement. Use analytics.overview separately to read data; a saved dashboard record does not prove populated chart results.

CLI/MCP adds its transport envelope; CLI --detail retains the full action result.

workflow · success 3 · HTTP 200

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested. Selected synthetic workspace: ws_insights_workflow. Fixture handles authorize no live request.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions plan app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions call app_topolo_insights.dashboards.list --data @payload.json --detail --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_insights.dashboards.list",
    "input": {}
  }
}

Captured raw Worker result

{
  "data": [
    {
      "id": "480d495c-5aa2-4ebe-84fa-6a21e7a276e2",
      "name": "Updated traffic",
      "description": null,
      "windowDays": 90,
      "sourceKey": null,
      "widgets": [
        {
          "id": "23f2abab-b9a1-4b41-a57a-22e230720150",
          "kind": "top-pages",
          "title": "Top pages",
          "size": "half",
          "position": 0
        }
      ],
      "createdAt": "2026-10-04T08:52:48.420Z",
      "updatedAt": "2026-10-04T08:52:48.509Z"
    }
  ]
}

HTTP 200. Discover data[].id for update/delete and retain the complete original configuration before replacement. Use analytics.overview separately to read data; a saved dashboard record does not prove populated chart results.

CLI/MCP adds its transport envelope; CLI --detail retains the full action result.

permission-refusals · refusal 4 · HTTP 403

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested. Selected synthetic workspace: ws_insights_merge. Fixture handles authorize no live request.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_insights.dashboards.list --data @payload.json --json
topolo actions plan app_topolo_insights.dashboards.list --data @payload.json --json

Captured raw Worker result

{
  "success": false,
  "error": {
    "code": "action_permission_required",
    "message": "Action \"dashboards.list\" requires permission \"workspace:read\".",
    "action": "dashboards.list"
  }
}

HTTP 403. The credential lacks the declared action permission. Inspect credential-scoped discovery in the same approved context; workspace role does not replace the permission.

CLI/MCP adds its transport envelope; CLI --detail retains the full action result.

Verify the outcome

  • Discover data[].id for update/delete and retain the complete original configuration before replacement.
  • Use analytics.overview separately to read data; a saved dashboard record does not prove populated chart results.

Errors and recovery

  • action_permission_required (HTTP 403): The credential lacks the declared action permission. Inspect credential-scoped discovery in the same approved context; workspace role does not replace the permission.

Only observed refusals are listed. This does not promise that external dependencies or every invalid payload have been exhaustively exercised.

Recovery boundary

This action does not change Insights records. Resolve the reported identity, permission, workspace or source problem in the approved context, then repeat the same read. A read result is not permission to modify its resources.

Evidence and limits

Actual exported Insights worker, all nine migrated D1 scripts and isolated local R2. Auth identity/grants/archive transport, queue delivery and Analytics Engine sink are synthetic; local queue processing is called explicitly. Notify and Nexus are disabled. No live website, provider, paid usage or deployed data erasure is tested.