dashboards

Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.

get/api/projects/{project_id}/dashboards/{id}/stream_tiles/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/dashboards/{id}/stream_tiles/
  • Auth: none declared

Path parameters

idinteger required

A unique integer value identifying this dashboard.

project_idstring required

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

Query parameters

filters_overridestring

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.

format'json' | 'txt'
layoutSize'sm' | 'xs'

Layout size for tile positioning. 'sm' (default) for standard, 'xs' for mobile. The snake_case alias layout_size is also accepted for backward compatibility.

variables_overridestring

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.

Response

No response body

Changes

No recorded changes to this operation across all 1 revision of this API.