Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reports
Publisher Documents
Reporting
Export & Automations
AI Lake
AI Assistant
    Conversations
    Dashboard Summary
      (EXPERIMENTAL) Summarize a dashboardpost(EXPERIMENTAL) Summarize a set of visualizationspost
    Document Takeaway
    Knowledge
    Knowledge Recommendations
    Memory Items
    LLM Providers
    Observability
    AI Search Data
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Dashboard Summary

Endpoint:/

(EXPERIMENTAL) Summarize a dashboard

POST
/api/v1/ai/workspaces/{workspace_id}/summary

Note: This API is an experimental and is going to change. Please, use it accordingly. Generates a natural-language summary of a dashboard's visualizations, optionally scoped by an explicit filter context.

(EXPERIMENTAL) Summarize a dashboard › path Parameters

  • workspace_idstring · required

(EXPERIMENTAL) Summarize a dashboard › Request Body

  • dashboardIdstring · minLength: 1 · required
  • filterContext

    AFM filters in the same shape consumed by the AFM execute endpoint, merged on top of each visualization's stored filters using the type-aware merge rules. Omit or send null to fall back to the dashboard's saved filter context. Send [] to explicitly apply no request filters.

  • formatHint
  • tabId

    Local identifier of the dashboard tab to summarize. When the dashboard has tabs and tabId is omitted, the first tab is used (matching the UI's default tab). A tabId that does not match any tab's localIdentifier returns 404. Supplying tabId for a dashboard without tabs returns 400. When tabId is combined with visualizations, every supplied visualization must belong to the selected tab; otherwise the request returns 400.

  • visualizations

(EXPERIMENTAL) Summarize a dashboard › Responses

Successful Response

  • filterContextarray · required
  • generatedAtstring · date-time · required
  • summarystring · required
  • visualizationsExcludedobject[] · required
  • visualizationsIncludedobject[] · required
  • tabId
POST /api/v1/ai/workspaces/{workspace_id}/summary

(EXPERIMENTAL) Summarize a set of visualizations

POST
/api/v1/ai/workspaces/{workspace_id}/summary/visualizations

Note: This API is an experimental and is going to change. Please, use it accordingly. Generates a natural-language summary of an explicit set of visualizations, which need not belong to any one dashboard. The filter context is required: with no dashboard there is no saved filter context to fall back on.

(EXPERIMENTAL) Summarize a set of visualizations › path Parameters

  • workspace_idstring · required

(EXPERIMENTAL) Summarize a set of visualizations › Request Body

  • filterContextarray · required

    AFM filters in the same shape consumed by the AFM execute endpoint, applied to every visualization on top of its stored filters. Send [] to apply no request filters. Each layer is merged on top of the one below it: attribute, ranking and inline filters are added and all apply together; a date filter replaces the lower layer's date filter on the same date dataset; a measure value filter replaces the lower layer's measure value filter on the same measure.

  • visualizationsarray · minItems: 1 · required

    Visualizations to summarize. They need not belong to any one dashboard. Each item is one placement, and each placement is executed and summarized separately. An item is a visualization ID or an object with visualizationId and its own filters. A visualization ID gets its stored filters and filterContext only. The same visualization can occur more than once.

  • formatHint

(EXPERIMENTAL) Summarize a set of visualizations › Responses

Successful Response

  • filterContextarray · required
  • generatedAtstring · date-time · required
  • summarystring · required
  • visualizationsExcludedobject[] · required
  • visualizationsIncludedobject[] · required
  • tabId
POST /api/v1/ai/workspaces/{workspace_id}/summary/visualizations
ConversationsDocument Takeaway