provider dashboards PUT /api/projects/{project_id}/dashboards/{id}/
@utdk/posthog /api/projects/{project_id}/dashboards/{id}/
dashboards_update
format query
enum: json, txt
id path required
A unique integer value identifying this dashboard.
integer
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

Try it

Authentication
Configure credentials for PostHog API
dashboardsUpdate
PUT/api/projects/{project_id}/dashboards/{id}/

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/.

Input

required
required
required
required
required

Path of the project-tree folder this dashboard is filed under in the file system, e.g. 'Unfiled/Dashboards'. An empty string means the project root; null means the dashboard has no file system entry. The dashboard's own name is not part of the path.

required
required
required
required

Custom color mapping for breakdown values.

ID of the color theme used for chart visualizations.

* `21` - Everyone in the project can edit * `37` - Only those invited to this dashboard can edit

required
required
required

The effective access level the user has for this object

required
required
required
required

List of quick filter IDs associated with this dashboard

required

Template key to create the dashboard from a predefined template.

ID of an existing dashboard to duplicate.

When deleting, also delete insights that are only on this dashboard.

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.dashboardsUpdate({
  "delete_insights": false
})