GOgooddata
Dashboard Summary

(EXPERIMENTAL) Summarize a dashboard

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.

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

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

workspace_idstring required

Request body

dashboardIdstring required
formatHintstring
tabIdstring

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.

visualizationsstring[]

Example request

{
  "filterContext": [
    {
      "positiveAttributeFilter": {
        "in": {
          "values": [
            "value1",
            "value2"
          ]
        },
        "label": {
          "localIdentifier": "sampleAutoGenerated0123_ID"
        }
      }
    }
  ]
}

Response

Successful Response

generatedAtstring date-time required
summarystring required
tabIdstring

Example response

{
  "filterContext": [
    {
      "positiveAttributeFilter": {
        "in": {
          "values": [
            "value1",
            "value2"
          ]
        },
        "label": {
          "localIdentifier": "sampleAutoGenerated0123_ID"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.