> ## Documentation Index > Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a dashboard with its latest widget data > The dashboard, its Python module, and each widget with its stored data, the period that data covers, `refreshed_at`, and the newest error: `error` is its full text (the route called, the status, the reason, the module line), for fixing the widget; `error_kind` is what the page tells a person: `PERMISSION` (a read refused for a permission group the dashboard lacks; add it to `permission_groups` with `PUT`), `VENDOR`, `TIMEOUT`, `CODE`, `INVALID_DATA`, `INPUT_FAILED` (an input widget failed), `CREDITS` or `SANDBOX`. **Reads only: never starts a refresh.** A widget is `stale` when its data is older than 15 minutes, never produced, or from an earlier definition; `pending` when a refresh was asked for after its last write (data or error): the current refresh run, or the next one to start, has it to do; also listed in `pending_widget_ids`. A widget nobody has asked to refresh is not pending. `?preview=true` caps each widget's `data` to its first rows and ~1 KB, for a model's context; without it `data` is complete (up to 512 KB per widget). To refresh, call `POST /dashboards//refresh`. 404 `dashboard_not_found` for another workspace's dashboard or a deleted one. ## OpenAPI ````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/dashboards/{dashboard_id} openapi: 3.1.0 info: description: >- Neo's public contract for the dashboard ChatAgent, partner integrations, and MSP automation. Every response is wrapped in a `{data, meta}` envelope; errors use `{error: {code, message, details?}, meta: {request_id}}`. Authenticate with a `Bearer neo_sk__` API key (service account) or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user feedback links) take a `signature` query parameter instead. title: Neo Public API version: 1.0.0 servers: - url: https://api.neoagent.io security: [] tags: - description: Service metadata — health, OpenAPI. name: Meta - description: Agents and workflows — read, version history, delete, stats. name: Agents - description: Agent/workflow execution history, sub-resources, retry/cancel. name: Executions - description: >- Every tool call the tenant's agents made in the last 30 days, within the caller's workflow access. name: Audit Log - description: PSA webhook events and their workflow-match results. name: Callbacks - description: Technician-in-the-loop approval requests. name: TIL requests - description: RMM script executions triggered by agents. name: RMM scripts - description: Dispatch-agent field-update decisions. name: Dispatch - description: The authenticated tenant. name: Tenant - description: Agent-builder schema catalogs (raw JSON payloads). name: Schemas - description: Escalate to the Neo team (HubSpot ticket). name: Escalation - description: Tenant settings. name: Settings - description: Tenant API-key management (dashboard JWT only). name: API keys - description: End-user feedback links (signed-URL auth). name: Feedback - description: End-client companies (CRUD + bulk-update). name: End companies - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack). name: Channels - description: PSA/RMM/M365 integration status and connection management. name: Integrations - description: Technician roster (controls TIL routing and paging). name: Technicians - description: Future runs queued for TRIGGERED agents. name: Scheduled work - description: Subscription state and customer-facing credit usage (no provider $). name: Billing - description: Inbox messages and announcements. name: Inbox & Comms - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog. name: Skills paths: /public-api/dashboards/{dashboard_id}: get: tags: - Dashboards summary: Get a dashboard with its latest widget data description: >- The dashboard, its Python module, and each widget with its stored data, the period that data covers, `refreshed_at`, and the newest error: `error` is its full text (the route called, the status, the reason, the module line), for fixing the widget; `error_kind` is what the page tells a person: `PERMISSION` (a read refused for a permission group the dashboard lacks; add it to `permission_groups` with `PUT`), `VENDOR`, `TIMEOUT`, `CODE`, `INVALID_DATA`, `INPUT_FAILED` (an input widget failed), `CREDITS` or `SANDBOX`. **Reads only: never starts a refresh.** A widget is `stale` when its data is older than 15 minutes, never produced, or from an earlier definition; `pending` when a refresh was asked for after its last write (data or error): the current refresh run, or the next one to start, has it to do; also listed in `pending_widget_ids`. A widget nobody has asked to refresh is not pending. `?preview=true` caps each widget's `data` to its first rows and ~1 KB, for a model's context; without it `data` is complete (up to 512 KB per widget). To refresh, call `POST /dashboards//refresh`. 404 `dashboard_not_found` for another workspace's dashboard or a deleted one. operationId: public_api.dashboards_get_get parameters: - in: path name: dashboard_id required: true schema: type: string - description: '`true` for capped widget data.' in: query name: preview required: false schema: type: boolean responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/PublicDashboardView' meta: $ref: '#/components/schemas/SuccessMeta' required: - data - meta type: object description: Success. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Bad request — malformed input. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Unauthenticated — missing or invalid credentials. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Forbidden — authenticated but not allowed. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Conflict — the resource is in a state that blocks this operation. '422': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Request validation failed. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Rate limited — see Retry-After. '500': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Internal server error. security: - bearerAuth: [] components: schemas: PublicDashboardView: properties: dashboard: $ref: '#/components/schemas/PublicDashboard' module: title: Module type: string pending_widget_ids: items: type: string title: Pending Widget Ids type: array preview: title: Preview type: boolean widgets: items: $ref: '#/components/schemas/PublicWidgetView' title: Widgets type: array required: - dashboard - module - widgets - preview - pending_widget_ids title: PublicDashboardView type: object SuccessMeta: properties: pagination: $ref: '#/components/schemas/Pagination' request_id: format: uuid type: string timings_ms: additionalProperties: type: number type: object warnings: description: >- Non-fatal warnings about the created/updated resource (e.g. an unhealthy PSA callback). items: type: string type: array required: - request_id - timings_ms type: object ErrorEnvelope: properties: error: properties: code: description: Stable machine-readable error code. type: string details: additionalProperties: true type: object message: type: string required: - code - message type: object meta: properties: request_id: format: uuid type: - string - 'null' type: object required: - error - meta type: object PublicDashboard: properties: created_at: format: date-time title: Created At type: string created_by: title: Created By type: string definition_id: title: Definition Id type: string id: title: Id type: string name: title: Name type: string period_rule: $ref: '#/components/schemas/PeriodRuleRequest' permission_groups: additionalProperties: items: type: string type: array title: Permission Groups type: object updated_at: format: date-time title: Updated At type: string required: - id - name - definition_id - period_rule - permission_groups - created_by - created_at - updated_at title: PublicDashboard type: object PublicWidgetView: properties: data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data error: anyOf: - type: string - type: 'null' title: Error error_at: anyOf: - format: date-time type: string - type: 'null' title: Error At error_kind: anyOf: - enum: - PERMISSION - VENDOR - TIMEOUT - CODE - INVALID_DATA - INPUT_FAILED - CREDITS - SANDBOX type: string - type: 'null' title: Error Kind pending: title: Pending type: boolean period_end: anyOf: - format: date-time type: string - type: 'null' title: Period End period_start: anyOf: - format: date-time type: string - type: 'null' title: Period Start refreshed_at: anyOf: - format: date-time type: string - type: 'null' title: Refreshed At stale: title: Stale type: boolean widget: $ref: '#/components/schemas/PublicWidget' required: - widget - data - error - error_kind - period_start - period_end - refreshed_at - error_at - stale - pending title: PublicWidgetView type: object Pagination: properties: has_more: type: boolean next_cursor: type: - string - 'null' required: - next_cursor - has_more type: object PeriodRuleRequest: properties: days: anyOf: - maximum: 366 minimum: 1 type: integer - type: 'null' default: null description: 'For LAST_N_DAYS: how many days back from now.' title: Days kind: description: The data window every widget reads, resolved at each refresh. enum: - LAST_N_DAYS - PREVIOUS_CALENDAR_WEEK - MONTH_TO_DATE title: Kind type: string timezone: description: >- IANA name, e.g. Europe/London; calendar weeks and months start at local midnight there. title: Timezone type: string required: - kind - timezone title: PeriodRuleRequest type: object PublicWidget: description: >- One widget of a dashboard: the preset component the page draws it with, where it sits on the grid, and the widgets whose data it reads. properties: component: description: >- The preset component the page draws the data with; the data has its shape. enum: - stat_group - bar_chart - line_chart - pie_chart - radial - table - progress_list - alert - text - grouped_list - heatmap - combo_chart - key_value - timeline - status_grid - scatter_chart - radar_chart - funnel_chart title: Component type: string data_schema: additionalProperties: true description: >- Optional JSON Schema (Draft 2020-12) pinning more of what widget_ returns, on top of the component's own shape. title: Data Schema type: object id: description: Lowercase id; the module defines widget_(ctx). pattern: ^[a-z][a-z0-9_]{0,39}$ title: Id type: string inputs: description: >- Widgets whose data this one reads as ctx.inputs (a summary widget); each must be listed before it. items: type: string title: Inputs type: array layout: $ref: '#/components/schemas/PublicWidgetLayout' title: maxLength: 120 minLength: 1 title: Title type: string required: - id - title - component - layout title: PublicWidget type: object PublicWidgetLayout: description: The widget's cell on the 12-column grid. `y` and `h` are in rows. properties: h: maximum: 12 minimum: 1 title: H type: integer w: maximum: 12 minimum: 1 title: W type: integer x: exclusiveMaximum: 12 minimum: 0 title: X type: integer 'y': minimum: 0 title: 'Y' type: integer required: - x - 'y' - w - h title: PublicWidgetLayout type: object securitySchemes: bearerAuth: description: >- `Authorization: Bearer ` where `` is either a `neo_sk__` API key (service account) or a Microsoft Entra ID access token (dashboard user). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.