Dashboards

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
POST
DELETE
POST
GET
PATCH
DELETE
POST
POST
POST
POST
POST
POST
PATCH
POST
GET
GET
Next page →

List all dashboards

Also available via the PostHog MCP server:

  • dashboards-get-all — Get all dashboards

Required API key scopes

dashboard:read

Query parameters

  • created_by
    string
  • exclude_generated
    boolean
  • folder
    string
  • format
    string
    One of: "json""txt"
  • limit
    integer
  • offset
    integer
  • ordering
    string
    One of: "-last_viewed_at"
  • pinned
    boolean
  • search
    string

Response


Example request

GET /api/projects/:project_id/dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "pinned": true,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "last_accessed_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z",
      "folder": "string",
      "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
      "file_system_path": "string",
      "is_shared": true,
      "deleted": true,
      "creation_mode": "default",
      "tags": [
        null
      ],
      "user_access_level": "string",
      "last_refresh": "2019-08-24T14:15:22Z",
      "team_id": 0,
      "search_match_type": "exact"
    }
  ]
}

Create dashboards

Also available via the PostHog MCP server:

  • dashboard-create — Create dashboard

Required API key scopes

dashboard:write

Query parameters

  • format
    string
    One of: "json""txt"
  • include_dashboards
    boolean

Request parameters

  • name
    string | null
  • description
    string
  • pinned
    boolean
  • deleted
    boolean
  • breakdown_colors
    Click to open
    array | null
  • data_color_theme_id
    integer | null
  • tags
    array
  • last_refresh
    string | null
  • quick_filter_ids
    array | null
  • grid_spacing
  • layout_compaction
  • group_display
  • groups
    object | null
  • group_titles
    object | null
  • use_template
    string
  • use_dashboard
    integer | null
  • delete_insights
    boolean
    Default: false
  • _create_in_folder
    string

Response


Example request

POST /api/projects/:project_id/dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

List all dashboards sharing

Required API key scopes

sharing_configuration:read

Path parameters

  • dashboard_id
    integer

Example request

GET /api/projects/:project_id/dashboards/:dashboard_id/sharing
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/sharing/

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": [
    {
      "id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "note": "string",
      "created_by_email": "string",
      "is_active": true
    }
  ],
  "user_access_level": "string",
  "has_relevant_access_controls": true
}

Create dashboards sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": [
    {
      "id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "note": "string",
      "created_by_email": "string",
      "is_active": true
    }
  ],
  "user_access_level": "string",
  "has_relevant_access_controls": true
}

Delete dashboards sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer
  • password_id
    string

Example request

DELETE /api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords/:password_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Create dashboards sharing refresh

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/dashboards/:dashboard_id/sharing/refresh
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/sharing/refresh/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": [
    {
      "id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "note": "string",
      "created_by_email": "string",
      "is_active": true
    }
  ],
  "user_access_level": "string",
  "has_relevant_access_controls": true
}

Retrieve dashboards

Also available via the PostHog MCP server:

  • dashboard-get — Get dashboard

Required API key scopes

dashboard:read

Path parameters

  • id
    integer

Query parameters

  • filters_override
    string
  • format
    string
    One of: "json""txt"
  • include_dashboards
    boolean
  • variables_override
    string

Response


Example request

GET /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update dashboards

Also available via the PostHog MCP server:

  • dashboard-update — Update dashboard

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"
  • include_dashboards
    boolean

Request parameters

  • name
    string | null
  • description
    string
  • pinned
    boolean
  • filters
  • breakdown_colors
    Click to open
    array | null
  • data_color_theme_id
    integer | null
  • tags
    array
  • quick_filter_ids
    array | null
  • grid_spacing
  • layout_compaction
  • group_display
  • groups
    object | null
  • group_titles
    object | null
  • tiles
    Click to open
    array
  • use_template
    string
  • use_dashboard
    integer | null
  • delete_insights
    boolean
    Default: false

Response


Example request

PATCH /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Delete dashboards

Also available via the PostHog MCP server:

  • dashboard-delete — Delete dashboard

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Example request

DELETE /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/

Example response

Status 405 No response body

Create dashboards add insight

Place an existing insight on this dashboard as a new tile. Requires edit access to the dashboard and view access to the insight. Returns the tile. Adding an insight the dashboard already shows returns its tile unchanged, and adding one that was removed from the dashboard restores its tile with its old layout. To take an insight off a dashboard, use delete_tile.

Required API key scopes

dashboard:writeinsight:read

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • insight_id
    integer

Response


Example request

POST /api/projects/:project_id/dashboards/:id/add_insight
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/add_insight/\
	-d insight_id="integer"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "dashboard_id": 0,
  "deleted": true
}

Create dashboards copy group

Copy a group of tiles and its settings to another dashboard.

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • fromDashboardId
    integer
  • groupKey
    string

Response


Example request

POST /api/projects/:project_id/dashboards/:id/copy_group
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/copy_group/\
	-d fromDashboardId="integer",\
	-d groupKey="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards copy tile

Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • fromDashboardId
    integer
  • tileId
    integer

Response


Example request

POST /api/projects/:project_id/dashboards/:id/copy_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/copy_tile/\
	-d fromDashboardId="integer",\
	-d tileId="integer"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards create text tile

Add a markdown text tile to a dashboard.

Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • type
    Default: text
  • body
    string
  • agent_context
    string | null
  • layouts
  • color
    string | null

Response


Example request

POST /api/projects/:project_id/dashboards/:id/create_text_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/create_text_tile/\
	-d body="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "insight": {
    "id": 0,
    "short_id": "string",
    "name": "string",
    "derived_name": "string",
    "query": {
      "embedded": null,
      "full": null,
      "hidePersonsModal": null,
      "hideTooltipOnScroll": null,
      "kind": "InsightVizNode",
      "showCorrelationTable": null,
      "showFilters": null,
      "showHeader": null,
      "showLastComputation": null,
      "showLastComputationRefresh": null,
      "showResults": null,
      "showTable": null,
      "source": {
        "aggregation_group_type_index": null,
        "breakdownFilter": null,
        "calendarHeatmapFilter": null,
        "compareFilter": null,
        "conversionGoal": null,
        "dataColorTheme": null,
        "dateRange": null,
        "filterTestAccounts": false,
        "interval": "day",
        "kind": "TrendsQuery",
        "marketingAnalyticsCostFallback": null,
        "modifiers": null,
        "properties": [],
        "response": null,
        "samplingFactor": null,
        "series": [
          {
            "custom_name": null,
            "event": null,
            "fixedProperties": null,
            "kind": "EventsNode",
            "limit": null,
            "math": null,
            "math_group_type_index": null,
            "math_hogql": null,
            "math_multiplier": null,
            "math_property": null,
            "math_property_revenue_currency": null,
            "math_property_type": null,
            "name": null,
            "optionalInFunnel": null,
            "orderBy": null,
            "properties": null,
            "response": null,
            "version": null
          }
        ],
        "tags": null,
        "trendsFilter": null,
        "version": null
      },
      "suppressSessionAnalysisWarning": null,
      "version": null,
      "vizSpecificOptions": null
    },
    "order": -2147483648,
    "deleted": true,
    "dashboards": [
      0
    ],
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_refresh": "2019-08-24T14:15:22Z",
    "cache_target_age": "2019-08-24T14:15:22Z",
    "next_allowed_client_refresh": "2019-08-24T14:15:22Z",
    "result": null,
    "hasMore": true,
    "columns": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "description": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [
      null
    ],
    "favorited": true,
    "last_modified_at": "2019-08-24T14:15:22Z",
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "is_sample": true,
    "user_access_level": "string",
    "timezone": "string",
    "is_cached": true,
    "query_status": null,
    "hogql": "string",
    "types": [
      null
    ],
    "resolved_date_range": {
      "date_from": "2019-08-24T14:15:22Z",
      "date_to": "2019-08-24T14:15:22Z"
    },
    "resolved_compare_date_range": {
      "date_from": "2019-08-24T14:15:22Z",
      "date_to": "2019-08-24T14:15:22Z"
    },
    "action_names": {
      "property1": "string",
      "property2": "string"
    },
    "query_scan": null,
    "warnings": [
      {
        "data_is_current": null,
        "message": "string",
        "schema_name": "string",
        "source_id": null,
        "source_type": "string",
        "status": "string",
        "table_name": "string",
        "type": "warehouse_sync"
      }
    ],
    "_create_in_folder": "string",
    "alerts": [
      null
    ],
    "filter_override_context": {
      "dashboard": null,
      "tile": null,
      "overridden_dashboard": null
    },
    "last_viewed_at": "2019-08-24T14:15:22Z",
    "search_match_type": "exact"
  },
  "text": {
    "id": 0,
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "body": "string",
    "agent_context": "string",
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "button_tile": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "url": "string",
    "text": "string",
    "placement": "left",
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "style": "primary",
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "widget": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "widget_type": "string",
    "name": "string",
    "description": "string",
    "config": {
      "notebookShortId": null,
      "snapshotId": null
    },
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "layouts": null,
  "color": "string",
  "filters_overrides": null,
  "show_description": true,
  "transparent_background": true,
  "group_key": "string",
  "badge": "winner"
}

Create dashboards delete

Soft-delete a single tile from a dashboard.

Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile object is preserved — only the dashboard tile is hidden. To delete the entire dashboard, use the dashboard delete endpoint instead.

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • tile_id
    integer

Example request

POST /api/projects/:project_id/dashboards/:id/delete_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/delete_tile/\
	-d tile_id="integer"

Example response

Status 204 No response body

Create dashboards move tile

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • to_dashboard
    integer
  • tile

Response


Example request

POST /api/projects/:project_id/dashboards/:id/move_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/move_tile/\
	-d to_dashboard="integer",\
	-d tile=undefined

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update dashboards move tile

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • to_dashboard
    integer
  • tile

Response


Example request

PATCH /api/projects/:project_id/dashboards/:id/move_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/move_tile/\
	-d to_dashboard="integer"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards reorder tiles

Required API key scopes

dashboard:write

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"

Request parameters

  • tile_order
    array
  • layout
    Default: preserve

Response


Example request

POST /api/projects/:project_id/dashboards/:id/reorder_tiles
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/reorder_tiles/\
	-d tile_order="array"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "file_system_id": "f44afb64-7f70-4727-9ce1-447b5b6aae38",
  "file_system_path": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": [
    {
      "breakdownValue": "string",
      "colorToken": "string",
      "breakdownType": "string",
      "breakdownProperty": "string",
      "source": "auto"
    }
  ],
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "user_access_level": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "customization": {
    "tile_spacing": "tight",
    "layout_compaction": "vertical",
    "group_display": "sections",
    "groups": {
      "property1": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      },
      "property2": {
        "title": "string",
        "collapsed": true,
        "color": "blue"
      }
    },
    "group_titles": {
      "property1": "string",
      "property2": "string"
    }
  },
  "grid_spacing": "tight",
  "layout_compaction": "vertical",
  "group_display": "sections",
  "groups": {
    "property1": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    },
    "property2": {
      "title": "string",
      "collapsed": true,
      "color": "blue"
    }
  },
  "group_titles": {
    "property1": "string",
    "property2": "string"
  },
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Retrieve dashboards run insights

Run all insights on a dashboard and return their results.

Required API key scopes

query:read

Path parameters

  • id
    integer

Query parameters

  • filters_override
    string
  • format
    string
    One of: "json""txt"
  • max_result_chars
    integer
  • output_format
    string
    One of: "json""optimized"
  • refresh
    string
    One of: "blocking""force_blocking""force_cache"
  • tile_ids
    string
  • variables_override
    string

Response


Example request

GET /api/projects/:project_id/dashboards/:id/run_insights
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/run_insights/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "id": 0,
      "insight": {
        "id": 0,
        "short_id": "string",
        "name": "string",
        "derived_name": "string",
        "result": null,
        "warnings": [
          {
            "data_is_current": null,
            "message": "string",
            "schema_name": "string",
            "source_id": null,
            "source_type": "string",
            "status": "string",
            "table_name": "string",
            "type": "warehouse_sync"
          }
        ],
        "user_access_level": "string"
      }
    }
  ]
}

Retrieve dashboards run widgets

Required API key scopes

dashboard:read

Path parameters

  • id
    integer

Query parameters

  • format
    string
    One of: "json""txt"
  • tile_ids
    string

Response


Example request

GET /api/projects/:project_id/dashboards/:id/run_widgets
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/run_widgets/

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "tile_id": 0,
      "widget_type": "string",
      "result": null,
      "error": "string"
    }
  ]
}
Next page →