v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Governance Insights

List governance insights

Retrieve the list of governance insights available to the organization. By default, only insight metadata is returned; pass withValues=true to also compute and include each insight's current and previous values. Insights can be filtered by product.

get/api/v2/governance/insights

Query parameters

withValuesboolean

Whether to compute and include the current and previous value of each insight. Defaults to false, in which case only insight metadata is returned.

orgUuidstring

The UUID of the organization to compute insights for. Defaults to the organization of the authenticated user. Used to retrieve insights for a child organization from a parent organization.

filter[product]string[]

Restrict the results to insights belonging to the given products. May be repeated to filter by multiple products. Matching is case-insensitive.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "audit_query": {
          "compute": {
            "aggregation": "cardinality",
            "interval": 86400000,
            "metric": "@usr.id"
          },
          "indexes": [
            "main"
          ],
          "query": "@evt.name:Dashboard",
          "source": "audit"
        },
        "best_practice": {
          "category": "access_governance",
          "deep_link": "/organization-settings/users?status=inactive",
          "description": "Review and deactivate users who have not logged in within the last 90 days.",
          "id": "bp_monitor_inactive_users",
          "impact": "Reduces unauthorized access risk.",
          "impact_hint": 1,
          "permissions": [
            "user_access_manage"
          ],
          "status": "active",
          "summary": "Inactive users with access increase your security surface area.",
          "title": "Monitor inactive users",
          "trigger_condition": "active_users",
          "trigger_type": "insight"
        },
        "description": "Number of users who have used the Dashboard in the last 30 days",
        "display_name": "Active Dashboards",
        "event_query": {
          "compute": {
            "aggregation": "count",
            "interval": 86400000
          },
          "indexes": [
            "main"
          ],
          "query": "source:cloudtrail"
        },
        "metric_query": {
          "query": "avg:system.cpu.user{*}",
          "reducer": "avg",
          "source": "metrics"
        },
        "old_value": 3274,
        "percentage_query": {
          "denominator_query": {
            "query": "avg:system.cpu.user{*}",
            "reducer": "avg",
            "source": "metrics"
          },
          "numerator_query": {
            "query": "avg:system.cpu.user{*}",
            "reducer": "avg",
            "source": "metrics"
          }
        },
        "product": "Usage",
        "query_config": {
          "chart_type": "line",
          "comparison_shift": "month",
          "directionality": "neutral",
          "effective_time_window_days": 30
        },
        "sort_order": 1,
        "state": "critical",
        "sub_product": "Indexes",
        "time_range": "month",
        "unit_name": "active dashboards",
        "usage_query": {
          "query": "logs_indexed_events",
          "reducer": "sum"
        },
        "value": 3601
      },
      "id": "498ee21f-8037-48b8-a961-a488692902f4",
      "type": "insight"
    }
  ]
}