Skip to main content
POST
/
dashboards
/
widgets
/
insights
Get AI-generated insights for a dashboard widget
curl --request POST \
  --url https://core.ravenna.ai/api/dashboards/widgets/insights \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "widgetId": "<string>",
  "dateRange": {
    "from": "<string>",
    "to": "<string>"
  },
  "ravFilters": [
    {
      "field": "<string>",
      "condition": "<string>",
      "value": "<string>",
      "given": "<string>"
    }
  ],
  "forceRefresh": true,
  "mode": "detailed"
}'
{
  "insights": {
    "summary": "<string>",
    "keyMetrics": [
      {
        "label": "<string>",
        "value": "<string>",
        "insight": "<string>"
      }
    ],
    "trends": [
      "<string>"
    ],
    "dataDistribution": "<string>"
  },
  "generatedAt": "<string>",
  "cached": true,
  "mode": "detailed"
}

Authorizations

x-ravenna-api-token
string
header
required

Body

application/json
widgetId
string
required
dateRange
object
ravFilters
object[]
forceRefresh
boolean
mode
enum<string>
Available options:
detailed,
concise

Response

Successful response

insights
object
required
  • Option 1
  • Option 2
generatedAt
string
required
cached
boolean
required
mode
enum<string>
required
Available options:
detailed,
concise