provider dashboards GET /api/projects/{project_id}/dashboards/{id}/run_insights/
@utdk/posthog /api/projects/{project_id}/dashboards/{id}/run_insights/
dashboards_run_insights_retrieve
Run all insights on a dashboard and return their results.
filters_override query
Object (or pre-encoded JSON string) to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. Accepts the same keys as the dashboard filters schema (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a sharing token.
string
format query
enum: json, txt
id path required
A unique integer value identifying this dashboard.
integer
output_format query
'optimized' (default) returns LLM-friendly formatted text per insight. 'json' returns the raw query result objects.
enum: json, optimized
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
refresh query
Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh, otherwise recalculates. 'force_blocking' always recalculates.
enum: blocking, force_blocking, force_cache
variables_override query
Object (or pre-encoded JSON string) to override dashboard variables for this request only (not persisted). Format: {"<variable_id>": {"code_name": "<code_name>", "variableId": "<variable_id>", "value": <new_value>}}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a sharing token.
string

Try it

Authentication
Configure credentials for PostHog API
dashboardsRunInsightsRetrieve
GET/api/projects/{project_id}/dashboards/{id}/run_insights/
Run all insights on a dashboard and return their results.

Parameters

required

A unique integer value identifying this dashboard.

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Object (or pre-encoded JSON string) to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. Accepts the same keys as the dashboard filters schema (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a sharing token.

'optimized' (default) returns LLM-friendly formatted text per insight. 'json' returns the raw query result objects.

Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh, otherwise recalculates. 'force_blocking' always recalculates.

Object (or pre-encoded JSON string) to override dashboard variables for this request only (not persisted). Format: {"<variable_id>": {"code_name": "<code_name>", "variableId": "<variable_id>", "value": <new_value>}}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a sharing token.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.dashboardsRunInsightsRetrieve()