@utdk/posthog 1.0.0-20260712.5-dev.e2949a6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
@@ -0,0 +1,1896 @@
1
+ # Dashboards
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsDashboardsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/`
8
+ - **OpenAPI operationId**: `environments_dashboards_list`
9
+ - **Path params**: None
10
+ - **Query params**: `folder`, `format`, `limit`, `offset`, `search`
11
+ - **Response codes**: `200`
12
+ - **Transport options**: None
13
+ - **TypeScript**: [Client interface](../types.ts)
14
+
15
+ **Inputs**
16
+
17
+ - Client input type: `{ [key: string]: unknown }`
18
+ - Client transport options: None
19
+
20
+ **Outputs**
21
+
22
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string | null; description: string; pinned: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsDashboardsListInput = Parameters<typeof posthog.environmentsDashboardsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsDashboardsListOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsList>>;
30
+
31
+ const result: EnvironmentsDashboardsListOutput = await posthog.environmentsDashboardsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string | null; description: string; pinned: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id...
34
+ ```
35
+
36
+ ### `posthog.environmentsDashboardsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/`
39
+ - **OpenAPI operationId**: `environments_dashboards_create`
40
+ - **Path params**: None
41
+ - **Query params**: `format`
42
+ - **Response codes**: `201`
43
+ - **Transport options**: None
44
+ - **TypeScript**: [Client interface](../types.ts)
45
+
46
+ **Inputs**
47
+
48
+ - Client input type: `{ [key: string]: unknown }`
49
+ - Client transport options: None
50
+
51
+ **Outputs**
52
+
53
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsDashboardsCreateInput = Parameters<typeof posthog.environmentsDashboardsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsDashboardsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCreate>>;
61
+
62
+ const result: EnvironmentsDashboardsCreateOutput = await posthog.environmentsDashboardsCreate();
63
+
64
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
65
+ ```
66
+
67
+ ### `posthog.environmentsDashboardsCollaboratorsList`
68
+
69
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/`
70
+ - **OpenAPI operationId**: `environments_dashboards_collaborators_list`
71
+ - **Path params**: `dashboard_id`
72
+ - **Query params**: None
73
+ - **Response codes**: `200`
74
+ - **Transport options**: None
75
+ - **TypeScript**: [Client interface](../types.ts)
76
+
77
+ **Inputs**
78
+
79
+ - Client input type: `{ [key: string]: unknown }`
80
+ - Client transport options: None
81
+
82
+ **Outputs**
83
+
84
+ - Client return type: `({ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: st...`
85
+ - OpenAPI response codes: `200`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type EnvironmentsDashboardsCollaboratorsListInput = Parameters<typeof posthog.environmentsDashboardsCollaboratorsList> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsDashboardsCollaboratorsListOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCollaboratorsList>>;
92
+
93
+ const result: EnvironmentsDashboardsCollaboratorsListOutput = await posthog.environmentsDashboardsCollaboratorsList();
94
+
95
+ // Result shape (from schema): ({ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: st...
96
+ ```
97
+
98
+ ### `posthog.environmentsDashboardsCollaboratorsCreate`
99
+
100
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/`
101
+ - **OpenAPI operationId**: `environments_dashboards_collaborators_create`
102
+ - **Path params**: `dashboard_id`
103
+ - **Query params**: None
104
+ - **Response codes**: `201`
105
+ - **Transport options**: None
106
+ - **TypeScript**: [Client interface](../types.ts)
107
+
108
+ **Inputs**
109
+
110
+ - Client input type: `{ [key: string]: unknown }`
111
+ - Client transport options: None
112
+
113
+ **Outputs**
114
+
115
+ - Client return type: `{ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: str...`
116
+ - OpenAPI response codes: `201`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsDashboardsCollaboratorsCreateInput = Parameters<typeof posthog.environmentsDashboardsCollaboratorsCreate> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsDashboardsCollaboratorsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCollaboratorsCreate>>;
123
+
124
+ const result: EnvironmentsDashboardsCollaboratorsCreateOutput = await posthog.environmentsDashboardsCollaboratorsCreate();
125
+
126
+ // Result shape (from schema): { id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: str...
127
+ ```
128
+
129
+ ### `posthog.environmentsDashboardsCollaboratorsDestroy`
130
+
131
+ - **HTTP**: `DELETE /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/`
132
+ - **OpenAPI operationId**: `environments_dashboards_collaborators_destroy`
133
+ - **Path params**: `dashboard_id`, `user__uuid`
134
+ - **Query params**: None
135
+ - **Response codes**: `204`
136
+ - **Transport options**: None
137
+ - **TypeScript**: [Client interface](../types.ts)
138
+
139
+ **Inputs**
140
+
141
+ - Client input type: `{ [key: string]: unknown }`
142
+ - Client transport options: None
143
+
144
+ **Outputs**
145
+
146
+ - Client return type: `unknown`
147
+ - OpenAPI response codes: `204`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsDashboardsCollaboratorsDestroyInput = Parameters<typeof posthog.environmentsDashboardsCollaboratorsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsDashboardsCollaboratorsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCollaboratorsDestroy>>;
154
+
155
+ const result: EnvironmentsDashboardsCollaboratorsDestroyOutput = await posthog.environmentsDashboardsCollaboratorsDestroy();
156
+
157
+ // Result shape (from schema): unknown
158
+ ```
159
+
160
+ ### `posthog.environmentsDashboardsSharingList`
161
+
162
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/`
163
+ - **OpenAPI operationId**: `environments_dashboards_sharing_list`
164
+ - **Path params**: `dashboard_id`
165
+ - **Query params**: None
166
+ - **Response codes**: `200`
167
+ - **Transport options**: None
168
+ - **TypeScript**: [Client interface](../types.ts)
169
+
170
+ **Inputs**
171
+
172
+ - Client input type: `{ [key: string]: unknown }`
173
+ - Client transport options: None
174
+
175
+ **Outputs**
176
+
177
+ - Client return type: `({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsDashboardsSharingListInput = Parameters<typeof posthog.environmentsDashboardsSharingList> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsDashboardsSharingListOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsSharingList>>;
185
+
186
+ const result: EnvironmentsDashboardsSharingListOutput = await posthog.environmentsDashboardsSharingList();
187
+
188
+ // Result shape (from schema): ({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...
189
+ ```
190
+
191
+ ### `posthog.environmentsDashboardsSharingPasswordsCreate`
192
+
193
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/`
194
+ - **What it does**: Create a new password for the sharing configuration.
195
+ - **OpenAPI operationId**: `environments_dashboards_sharing_passwords_create`
196
+ - **Path params**: `dashboard_id`
197
+ - **Query params**: None
198
+ - **Response codes**: `200`
199
+ - **Transport options**: None
200
+ - **TypeScript**: [Client interface](../types.ts)
201
+
202
+ **Inputs**
203
+
204
+ - Client input type: `{ [key: string]: unknown }`
205
+ - Client transport options: None
206
+
207
+ **Outputs**
208
+
209
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
210
+ - OpenAPI response codes: `200`
211
+
212
+ ```ts
213
+ import posthog from "@utdk/posthog";
214
+
215
+ type EnvironmentsDashboardsSharingPasswordsCreateInput = Parameters<typeof posthog.environmentsDashboardsSharingPasswordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
216
+ type EnvironmentsDashboardsSharingPasswordsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsSharingPasswordsCreate>>;
217
+
218
+ const result: EnvironmentsDashboardsSharingPasswordsCreateOutput = await posthog.environmentsDashboardsSharingPasswordsCreate();
219
+
220
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
221
+ ```
222
+
223
+ ### `posthog.environmentsDashboardsSharingPasswordsDestroy`
224
+
225
+ - **HTTP**: `DELETE /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/`
226
+ - **What it does**: Delete a password from the sharing configuration.
227
+ - **OpenAPI operationId**: `environments_dashboards_sharing_passwords_destroy`
228
+ - **Path params**: `dashboard_id`, `password_id`
229
+ - **Query params**: None
230
+ - **Response codes**: `204`
231
+ - **Transport options**: None
232
+ - **TypeScript**: [Client interface](../types.ts)
233
+
234
+ **Inputs**
235
+
236
+ - Client input type: `{ [key: string]: unknown }`
237
+ - Client transport options: None
238
+
239
+ **Outputs**
240
+
241
+ - Client return type: `unknown`
242
+ - OpenAPI response codes: `204`
243
+
244
+ ```ts
245
+ import posthog from "@utdk/posthog";
246
+
247
+ type EnvironmentsDashboardsSharingPasswordsDestroyInput = Parameters<typeof posthog.environmentsDashboardsSharingPasswordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
248
+ type EnvironmentsDashboardsSharingPasswordsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsSharingPasswordsDestroy>>;
249
+
250
+ const result: EnvironmentsDashboardsSharingPasswordsDestroyOutput = await posthog.environmentsDashboardsSharingPasswordsDestroy();
251
+
252
+ // Result shape (from schema): unknown
253
+ ```
254
+
255
+ ### `posthog.environmentsDashboardsSharingRefreshCreate`
256
+
257
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/`
258
+ - **OpenAPI operationId**: `environments_dashboards_sharing_refresh_create`
259
+ - **Path params**: `dashboard_id`
260
+ - **Query params**: None
261
+ - **Response codes**: `200`
262
+ - **Transport options**: None
263
+ - **TypeScript**: [Client interface](../types.ts)
264
+
265
+ **Inputs**
266
+
267
+ - Client input type: `{ [key: string]: unknown }`
268
+ - Client transport options: None
269
+
270
+ **Outputs**
271
+
272
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
273
+ - OpenAPI response codes: `200`
274
+
275
+ ```ts
276
+ import posthog from "@utdk/posthog";
277
+
278
+ type EnvironmentsDashboardsSharingRefreshCreateInput = Parameters<typeof posthog.environmentsDashboardsSharingRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
279
+ type EnvironmentsDashboardsSharingRefreshCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsSharingRefreshCreate>>;
280
+
281
+ const result: EnvironmentsDashboardsSharingRefreshCreateOutput = await posthog.environmentsDashboardsSharingRefreshCreate();
282
+
283
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
284
+ ```
285
+
286
+ ### `posthog.environmentsDashboardsDestroy`
287
+
288
+ - **HTTP**: `DELETE /api/environments/{environment_id}/dashboards/{id}/`
289
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
290
+ - **OpenAPI operationId**: `environments_dashboards_destroy`
291
+ - **Path params**: `id`
292
+ - **Query params**: `format`
293
+ - **Response codes**: `405`
294
+ - **Transport options**: None
295
+ - **TypeScript**: [Client interface](../types.ts)
296
+
297
+ **Inputs**
298
+
299
+ - Client input type: `{ [key: string]: unknown }`
300
+ - Client transport options: None
301
+
302
+ **Outputs**
303
+
304
+ - Client return type: `unknown`
305
+ - OpenAPI response codes: `405`
306
+
307
+ ```ts
308
+ import posthog from "@utdk/posthog";
309
+
310
+ type EnvironmentsDashboardsDestroyInput = Parameters<typeof posthog.environmentsDashboardsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
311
+ type EnvironmentsDashboardsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsDestroy>>;
312
+
313
+ const result: EnvironmentsDashboardsDestroyOutput = await posthog.environmentsDashboardsDestroy();
314
+
315
+ // Result shape (from schema): unknown
316
+ ```
317
+
318
+ ### `posthog.environmentsDashboardsRetrieve`
319
+
320
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{id}/`
321
+ - **OpenAPI operationId**: `environments_dashboards_retrieve`
322
+ - **Path params**: `id`
323
+ - **Query params**: `filters_override`, `format`, `variables_override`
324
+ - **Response codes**: `200`
325
+ - **Transport options**: None
326
+ - **TypeScript**: [Client interface](../types.ts)
327
+
328
+ **Inputs**
329
+
330
+ - Client input type: `{ [key: string]: unknown }`
331
+ - Client transport options: None
332
+
333
+ **Outputs**
334
+
335
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
336
+ - OpenAPI response codes: `200`
337
+
338
+ ```ts
339
+ import posthog from "@utdk/posthog";
340
+
341
+ type EnvironmentsDashboardsRetrieveInput = Parameters<typeof posthog.environmentsDashboardsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
342
+ type EnvironmentsDashboardsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsRetrieve>>;
343
+
344
+ const result: EnvironmentsDashboardsRetrieveOutput = await posthog.environmentsDashboardsRetrieve();
345
+
346
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
347
+ ```
348
+
349
+ ### `posthog.environmentsDashboardsPartialUpdate`
350
+
351
+ - **HTTP**: `PATCH /api/environments/{environment_id}/dashboards/{id}/`
352
+ - **OpenAPI operationId**: `environments_dashboards_partial_update`
353
+ - **Path params**: `id`
354
+ - **Query params**: `format`
355
+ - **Response codes**: `200`
356
+ - **Transport options**: None
357
+ - **TypeScript**: [Client interface](../types.ts)
358
+
359
+ **Inputs**
360
+
361
+ - Client input type: `{ [key: string]: unknown }`
362
+ - Client transport options: None
363
+
364
+ **Outputs**
365
+
366
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
367
+ - OpenAPI response codes: `200`
368
+
369
+ ```ts
370
+ import posthog from "@utdk/posthog";
371
+
372
+ type EnvironmentsDashboardsPartialUpdateInput = Parameters<typeof posthog.environmentsDashboardsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
373
+ type EnvironmentsDashboardsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsPartialUpdate>>;
374
+
375
+ const result: EnvironmentsDashboardsPartialUpdateOutput = await posthog.environmentsDashboardsPartialUpdate();
376
+
377
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
378
+ ```
379
+
380
+ ### `posthog.environmentsDashboardsUpdate`
381
+
382
+ - **HTTP**: `PUT /api/environments/{environment_id}/dashboards/{id}/`
383
+ - **OpenAPI operationId**: `environments_dashboards_update`
384
+ - **Path params**: `id`
385
+ - **Query params**: `format`
386
+ - **Response codes**: `200`
387
+ - **Transport options**: None
388
+ - **TypeScript**: [Client interface](../types.ts)
389
+
390
+ **Inputs**
391
+
392
+ - Client input type: `{ [key: string]: unknown }`
393
+ - Client transport options: None
394
+
395
+ **Outputs**
396
+
397
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
398
+ - OpenAPI response codes: `200`
399
+
400
+ ```ts
401
+ import posthog from "@utdk/posthog";
402
+
403
+ type EnvironmentsDashboardsUpdateInput = Parameters<typeof posthog.environmentsDashboardsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
404
+ type EnvironmentsDashboardsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsUpdate>>;
405
+
406
+ const result: EnvironmentsDashboardsUpdateOutput = await posthog.environmentsDashboardsUpdate();
407
+
408
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
409
+ ```
410
+
411
+ ### `posthog.environmentsDashboardsCopyTileCreate`
412
+
413
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/copy_tile/`
414
+ - **What it does**: Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).
415
+ - **OpenAPI operationId**: `environments_dashboards_copy_tile_create`
416
+ - **Path params**: `id`
417
+ - **Query params**: `format`
418
+ - **Response codes**: `200`
419
+ - **Transport options**: None
420
+ - **TypeScript**: [Client interface](../types.ts)
421
+
422
+ **Inputs**
423
+
424
+ - Client input type: `{ [key: string]: unknown }`
425
+ - Client transport options: None
426
+
427
+ **Outputs**
428
+
429
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
430
+ - OpenAPI response codes: `200`
431
+
432
+ ```ts
433
+ import posthog from "@utdk/posthog";
434
+
435
+ type EnvironmentsDashboardsCopyTileCreateInput = Parameters<typeof posthog.environmentsDashboardsCopyTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
436
+ type EnvironmentsDashboardsCopyTileCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCopyTileCreate>>;
437
+
438
+ const result: EnvironmentsDashboardsCopyTileCreateOutput = await posthog.environmentsDashboardsCopyTileCreate();
439
+
440
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
441
+ ```
442
+
443
+ ### `posthog.environmentsDashboardsCreateTextTileCreate`
444
+
445
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/create_text_tile/`
446
+ - **What it does**: Add a markdown text tile to a dashboard.
447
+
448
+ Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers,
449
+ or annotations between insight tiles to give the dashboard structure.
450
+ - **OpenAPI operationId**: `environments_dashboards_create_text_tile_create`
451
+ - **Path params**: `id`
452
+ - **Query params**: `format`
453
+ - **Response codes**: `201`
454
+ - **Transport options**: None
455
+ - **TypeScript**: [Client interface](../types.ts)
456
+
457
+ **Inputs**
458
+
459
+ - Client input type: `{ [key: string]: unknown }`
460
+ - Client transport options: None
461
+
462
+ **Outputs**
463
+
464
+ - Client return type: `{ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...`
465
+ - OpenAPI response codes: `201`
466
+
467
+ ```ts
468
+ import posthog from "@utdk/posthog";
469
+
470
+ type EnvironmentsDashboardsCreateTextTileCreateInput = Parameters<typeof posthog.environmentsDashboardsCreateTextTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
471
+ type EnvironmentsDashboardsCreateTextTileCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCreateTextTileCreate>>;
472
+
473
+ const result: EnvironmentsDashboardsCreateTextTileCreateOutput = await posthog.environmentsDashboardsCreateTextTileCreate();
474
+
475
+ // Result shape (from schema): { id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...
476
+ ```
477
+
478
+ ### `posthog.environmentsDashboardsDeleteTile`
479
+
480
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/delete_tile/`
481
+ - **What it does**: Soft-delete a single tile from a dashboard.
482
+
483
+ Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile
484
+ object is preserved — only the dashboard tile is hidden. To delete the entire dashboard,
485
+ use the dashboard delete endpoint instead.
486
+ - **OpenAPI operationId**: `environments_dashboards_delete_tile`
487
+ - **Path params**: `id`
488
+ - **Query params**: `format`
489
+ - **Response codes**: `204`
490
+ - **Transport options**: None
491
+ - **TypeScript**: [Client interface](../types.ts)
492
+
493
+ **Inputs**
494
+
495
+ - Client input type: `{ [key: string]: unknown }`
496
+ - Client transport options: None
497
+
498
+ **Outputs**
499
+
500
+ - Client return type: `unknown`
501
+ - OpenAPI response codes: `204`
502
+
503
+ ```ts
504
+ import posthog from "@utdk/posthog";
505
+
506
+ type EnvironmentsDashboardsDeleteTileInput = Parameters<typeof posthog.environmentsDashboardsDeleteTile> extends [infer T, ...unknown[]] ? T : undefined;
507
+ type EnvironmentsDashboardsDeleteTileOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsDeleteTile>>;
508
+
509
+ const result: EnvironmentsDashboardsDeleteTileOutput = await posthog.environmentsDashboardsDeleteTile();
510
+
511
+ // Result shape (from schema): unknown
512
+ ```
513
+
514
+ ### `posthog.environmentsDashboardsMoveTilePartialUpdate`
515
+
516
+ - **HTTP**: `PATCH /api/environments/{environment_id}/dashboards/{id}/move_tile/`
517
+ - **OpenAPI operationId**: `environments_dashboards_move_tile_partial_update`
518
+ - **Path params**: `id`
519
+ - **Query params**: `format`
520
+ - **Response codes**: `200`
521
+ - **Transport options**: None
522
+ - **TypeScript**: [Client interface](../types.ts)
523
+
524
+ **Inputs**
525
+
526
+ - Client input type: `{ [key: string]: unknown }`
527
+ - Client transport options: None
528
+
529
+ **Outputs**
530
+
531
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
532
+ - OpenAPI response codes: `200`
533
+
534
+ ```ts
535
+ import posthog from "@utdk/posthog";
536
+
537
+ type EnvironmentsDashboardsMoveTilePartialUpdateInput = Parameters<typeof posthog.environmentsDashboardsMoveTilePartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
538
+ type EnvironmentsDashboardsMoveTilePartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsMoveTilePartialUpdate>>;
539
+
540
+ const result: EnvironmentsDashboardsMoveTilePartialUpdateOutput = await posthog.environmentsDashboardsMoveTilePartialUpdate();
541
+
542
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
543
+ ```
544
+
545
+ ### `posthog.environmentsDashboardsMoveTileCreate`
546
+
547
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/move_tile/`
548
+ - **OpenAPI operationId**: `environments_dashboards_move_tile_create`
549
+ - **Path params**: `id`
550
+ - **Query params**: `format`
551
+ - **Response codes**: `200`
552
+ - **Transport options**: None
553
+ - **TypeScript**: [Client interface](../types.ts)
554
+
555
+ **Inputs**
556
+
557
+ - Client input type: `{ [key: string]: unknown }`
558
+ - Client transport options: None
559
+
560
+ **Outputs**
561
+
562
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
563
+ - OpenAPI response codes: `200`
564
+
565
+ ```ts
566
+ import posthog from "@utdk/posthog";
567
+
568
+ type EnvironmentsDashboardsMoveTileCreateInput = Parameters<typeof posthog.environmentsDashboardsMoveTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
569
+ type EnvironmentsDashboardsMoveTileCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsMoveTileCreate>>;
570
+
571
+ const result: EnvironmentsDashboardsMoveTileCreateOutput = await posthog.environmentsDashboardsMoveTileCreate();
572
+
573
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
574
+ ```
575
+
576
+ ### `posthog.environmentsDashboardsReorderTilesCreate`
577
+
578
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/reorder_tiles/`
579
+ - **OpenAPI operationId**: `environments_dashboards_reorder_tiles_create`
580
+ - **Path params**: `id`
581
+ - **Query params**: `format`
582
+ - **Response codes**: `200`
583
+ - **Transport options**: None
584
+ - **TypeScript**: [Client interface](../types.ts)
585
+
586
+ **Inputs**
587
+
588
+ - Client input type: `{ [key: string]: unknown }`
589
+ - Client transport options: None
590
+
591
+ **Outputs**
592
+
593
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
594
+ - OpenAPI response codes: `200`
595
+
596
+ ```ts
597
+ import posthog from "@utdk/posthog";
598
+
599
+ type EnvironmentsDashboardsReorderTilesCreateInput = Parameters<typeof posthog.environmentsDashboardsReorderTilesCreate> extends [infer T, ...unknown[]] ? T : undefined;
600
+ type EnvironmentsDashboardsReorderTilesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsReorderTilesCreate>>;
601
+
602
+ const result: EnvironmentsDashboardsReorderTilesCreateOutput = await posthog.environmentsDashboardsReorderTilesCreate();
603
+
604
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
605
+ ```
606
+
607
+ ### `posthog.environmentsDashboardsRunInsightsRetrieve`
608
+
609
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{id}/run_insights/`
610
+ - **What it does**: Run all insights on a dashboard and return their results.
611
+ - **OpenAPI operationId**: `environments_dashboards_run_insights_retrieve`
612
+ - **Path params**: `id`
613
+ - **Query params**: `filters_override`, `format`, `output_format`, `refresh`, `variables_override`
614
+ - **Response codes**: `200`
615
+ - **Transport options**: None
616
+ - **TypeScript**: [Client interface](../types.ts)
617
+
618
+ **Inputs**
619
+
620
+ - Client input type: `{ [key: string]: unknown }`
621
+ - Client transport options: None
622
+
623
+ **Outputs**
624
+
625
+ - Client return type: `{ results: ({ id?: number; insight: { id: number; short_id: string; name: string | null; derived_name: string | null; result: unknown } })[] }`
626
+ - OpenAPI response codes: `200`
627
+
628
+ ```ts
629
+ import posthog from "@utdk/posthog";
630
+
631
+ type EnvironmentsDashboardsRunInsightsRetrieveInput = Parameters<typeof posthog.environmentsDashboardsRunInsightsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
632
+ type EnvironmentsDashboardsRunInsightsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsRunInsightsRetrieve>>;
633
+
634
+ const result: EnvironmentsDashboardsRunInsightsRetrieveOutput = await posthog.environmentsDashboardsRunInsightsRetrieve();
635
+
636
+ // Result shape (from schema): { results: ({ id?: number; insight: { id: number; short_id: string; name: string | null; derived_name: string | null; result: unknown } })[] }
637
+ ```
638
+
639
+ ### `posthog.environmentsDashboardsRunWidgetsRetrieve`
640
+
641
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{id}/run_widgets/`
642
+ - **OpenAPI operationId**: `environments_dashboards_run_widgets_retrieve`
643
+ - **Path params**: `id`
644
+ - **Query params**: `format`, `tile_ids`
645
+ - **Response codes**: `200`
646
+ - **Transport options**: None
647
+ - **TypeScript**: [Client interface](../types.ts)
648
+
649
+ **Inputs**
650
+
651
+ - Client input type: `{ [key: string]: unknown }`
652
+ - Client transport options: None
653
+
654
+ **Outputs**
655
+
656
+ - Client return type: `{ results: ({ tile_id: number; widget_type: string | null; result: unknown; error: string | null })[] }`
657
+ - OpenAPI response codes: `200`
658
+
659
+ ```ts
660
+ import posthog from "@utdk/posthog";
661
+
662
+ type EnvironmentsDashboardsRunWidgetsRetrieveInput = Parameters<typeof posthog.environmentsDashboardsRunWidgetsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
663
+ type EnvironmentsDashboardsRunWidgetsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsRunWidgetsRetrieve>>;
664
+
665
+ const result: EnvironmentsDashboardsRunWidgetsRetrieveOutput = await posthog.environmentsDashboardsRunWidgetsRetrieve();
666
+
667
+ // Result shape (from schema): { results: ({ tile_id: number; widget_type: string | null; result: unknown; error: string | null })[] }
668
+ ```
669
+
670
+ ### `posthog.environmentsDashboardsStreamTilesRetrieve`
671
+
672
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/{id}/stream_tiles/`
673
+ - **What it does**: Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
674
+ - **OpenAPI operationId**: `environments_dashboards_stream_tiles_retrieve`
675
+ - **Path params**: `id`
676
+ - **Query params**: `filters_override`, `format`, `layoutSize`, `variables_override`
677
+ - **Response codes**: `200`
678
+ - **Transport options**: None
679
+ - **TypeScript**: [Client interface](../types.ts)
680
+
681
+ **Inputs**
682
+
683
+ - Client input type: `{ [key: string]: unknown }`
684
+ - Client transport options: None
685
+
686
+ **Outputs**
687
+
688
+ - Client return type: `unknown`
689
+ - OpenAPI response codes: `200`
690
+
691
+ ```ts
692
+ import posthog from "@utdk/posthog";
693
+
694
+ type EnvironmentsDashboardsStreamTilesRetrieveInput = Parameters<typeof posthog.environmentsDashboardsStreamTilesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
695
+ type EnvironmentsDashboardsStreamTilesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsStreamTilesRetrieve>>;
696
+
697
+ const result: EnvironmentsDashboardsStreamTilesRetrieveOutput = await posthog.environmentsDashboardsStreamTilesRetrieve();
698
+
699
+ // Result shape (from schema): unknown
700
+ ```
701
+
702
+ ### `posthog.environmentsDashboardsUpdateTextTileCreate`
703
+
704
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/update_text_tile/`
705
+ - **What it does**: Update the markdown body, layout, or color of an existing text tile on a dashboard.
706
+ - **OpenAPI operationId**: `environments_dashboards_update_text_tile_create`
707
+ - **Path params**: `id`
708
+ - **Query params**: `format`
709
+ - **Response codes**: `200`
710
+ - **Transport options**: None
711
+ - **TypeScript**: [Client interface](../types.ts)
712
+
713
+ **Inputs**
714
+
715
+ - Client input type: `{ [key: string]: unknown }`
716
+ - Client transport options: None
717
+
718
+ **Outputs**
719
+
720
+ - Client return type: `{ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...`
721
+ - OpenAPI response codes: `200`
722
+
723
+ ```ts
724
+ import posthog from "@utdk/posthog";
725
+
726
+ type EnvironmentsDashboardsUpdateTextTileCreateInput = Parameters<typeof posthog.environmentsDashboardsUpdateTextTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
727
+ type EnvironmentsDashboardsUpdateTextTileCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsUpdateTextTileCreate>>;
728
+
729
+ const result: EnvironmentsDashboardsUpdateTextTileCreateOutput = await posthog.environmentsDashboardsUpdateTextTileCreate();
730
+
731
+ // Result shape (from schema): { id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...
732
+ ```
733
+
734
+ ### `posthog.environmentsDashboardsUpdateWidgetsBatch`
735
+
736
+ - **HTTP**: `PATCH /api/environments/{environment_id}/dashboards/{id}/widgets/batch_update/`
737
+ - **What it does**: Update the settings of existing widgets in place, atomically — config, name, and description.
738
+
739
+ Each entry targets a widget by its tile_id and reuses the same write path as the dashboard PATCH endpoint.
740
+ The widget_type is immutable. This edits widget settings only (config, name, description); tile placement
741
+ (layouts, show_description) is a dashboard concern — use the dashboard PATCH endpoint or reorder_tiles for
742
+ that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to
743
+ remove one, use delete_tile.
744
+ - **OpenAPI operationId**: `environments_dashboards_update_widgets_batch`
745
+ - **Path params**: `id`
746
+ - **Query params**: `format`
747
+ - **Response codes**: `200`
748
+ - **Transport options**: None
749
+ - **TypeScript**: [Client interface](../types.ts)
750
+
751
+ **Inputs**
752
+
753
+ - Client input type: `{ [key: string]: unknown }`
754
+ - Client transport options: None
755
+
756
+ **Outputs**
757
+
758
+ - Client return type: `{ tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...`
759
+ - OpenAPI response codes: `200`
760
+
761
+ ```ts
762
+ import posthog from "@utdk/posthog";
763
+
764
+ type EnvironmentsDashboardsUpdateWidgetsBatchInput = Parameters<typeof posthog.environmentsDashboardsUpdateWidgetsBatch> extends [infer T, ...unknown[]] ? T : undefined;
765
+ type EnvironmentsDashboardsUpdateWidgetsBatchOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsUpdateWidgetsBatch>>;
766
+
767
+ const result: EnvironmentsDashboardsUpdateWidgetsBatchOutput = await posthog.environmentsDashboardsUpdateWidgetsBatch();
768
+
769
+ // Result shape (from schema): { tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...
770
+ ```
771
+
772
+ ### `posthog.environmentsDashboardsWidgetsBatchCreate`
773
+
774
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/{id}/widgets/batch/`
775
+ - **What it does**: Add multiple widget tiles to a dashboard in one atomic request.
776
+ - **OpenAPI operationId**: `environments_dashboards_widgets_batch_create`
777
+ - **Path params**: `id`
778
+ - **Query params**: `format`
779
+ - **Response codes**: `201`
780
+ - **Transport options**: None
781
+ - **TypeScript**: [Client interface](../types.ts)
782
+
783
+ **Inputs**
784
+
785
+ - Client input type: `{ [key: string]: unknown }`
786
+ - Client transport options: None
787
+
788
+ **Outputs**
789
+
790
+ - Client return type: `{ tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...`
791
+ - OpenAPI response codes: `201`
792
+
793
+ ```ts
794
+ import posthog from "@utdk/posthog";
795
+
796
+ type EnvironmentsDashboardsWidgetsBatchCreateInput = Parameters<typeof posthog.environmentsDashboardsWidgetsBatchCreate> extends [infer T, ...unknown[]] ? T : undefined;
797
+ type EnvironmentsDashboardsWidgetsBatchCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsWidgetsBatchCreate>>;
798
+
799
+ const result: EnvironmentsDashboardsWidgetsBatchCreateOutput = await posthog.environmentsDashboardsWidgetsBatchCreate();
800
+
801
+ // Result shape (from schema): { tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...
802
+ ```
803
+
804
+ ### `posthog.environmentsDashboardsBulkUpdateTagsCreate`
805
+
806
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/bulk_update_tags/`
807
+ - **What it does**: Bulk update tags on multiple objects.
808
+
809
+ PAT access: this action has no ``required_scopes=`` on the decorator —
810
+ inheriting viewsets must add ``"bulk_update_tags"`` to their
811
+ ``scope_object_write_actions`` list to accept personal API keys.
812
+ Without that opt-in, ``APIScopePermission`` rejects PAT requests with
813
+ "This action does not support personal API key access". Done per-viewset
814
+ so granting ``<scope>:write`` for one resource doesn't leak access to
815
+ sibling resources that share this mixin.
816
+
817
+ Accepts:
818
+ - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}
819
+
820
+ Actions:
821
+ - "add": Add tags to existing tags on each object
822
+ - "remove": Remove specific tags from each object
823
+ - "set": Replace all tags on each object with the provided list
824
+ - **OpenAPI operationId**: `environments_dashboards_bulk_update_tags_create`
825
+ - **Path params**: None
826
+ - **Query params**: `format`
827
+ - **Response codes**: `200`
828
+ - **Transport options**: None
829
+ - **TypeScript**: [Client interface](../types.ts)
830
+
831
+ **Inputs**
832
+
833
+ - Client input type: `{ [key: string]: unknown }`
834
+ - Client transport options: None
835
+
836
+ **Outputs**
837
+
838
+ - Client return type: `{ updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }`
839
+ - OpenAPI response codes: `200`
840
+
841
+ ```ts
842
+ import posthog from "@utdk/posthog";
843
+
844
+ type EnvironmentsDashboardsBulkUpdateTagsCreateInput = Parameters<typeof posthog.environmentsDashboardsBulkUpdateTagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
845
+ type EnvironmentsDashboardsBulkUpdateTagsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsBulkUpdateTagsCreate>>;
846
+
847
+ const result: EnvironmentsDashboardsBulkUpdateTagsCreateOutput = await posthog.environmentsDashboardsBulkUpdateTagsCreate();
848
+
849
+ // Result shape (from schema): { updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }
850
+ ```
851
+
852
+ ### `posthog.environmentsDashboardsCreateFromTemplateJsonCreate`
853
+
854
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/create_from_template_json/`
855
+ - **OpenAPI operationId**: `environments_dashboards_create_from_template_json_create`
856
+ - **Path params**: None
857
+ - **Query params**: `format`
858
+ - **Response codes**: `200`
859
+ - **Transport options**: None
860
+ - **TypeScript**: [Client interface](../types.ts)
861
+
862
+ **Inputs**
863
+
864
+ - Client input type: `{ [key: string]: unknown }`
865
+ - Client transport options: None
866
+
867
+ **Outputs**
868
+
869
+ - Client return type: `unknown`
870
+ - OpenAPI response codes: `200`
871
+
872
+ ```ts
873
+ import posthog from "@utdk/posthog";
874
+
875
+ type EnvironmentsDashboardsCreateFromTemplateJsonCreateInput = Parameters<typeof posthog.environmentsDashboardsCreateFromTemplateJsonCreate> extends [infer T, ...unknown[]] ? T : undefined;
876
+ type EnvironmentsDashboardsCreateFromTemplateJsonCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCreateFromTemplateJsonCreate>>;
877
+
878
+ const result: EnvironmentsDashboardsCreateFromTemplateJsonCreateOutput = await posthog.environmentsDashboardsCreateFromTemplateJsonCreate();
879
+
880
+ // Result shape (from schema): unknown
881
+ ```
882
+
883
+ ### `posthog.environmentsDashboardsCreateUnlistedDashboardCreate`
884
+
885
+ - **HTTP**: `POST /api/environments/{environment_id}/dashboards/create_unlisted_dashboard/`
886
+ - **What it does**: Creates an unlisted dashboard from template by tag.
887
+ Enforces uniqueness (one per tag per team).
888
+ Returns 409 if unlisted dashboard with this tag already exists.
889
+ - **OpenAPI operationId**: `environments_dashboards_create_unlisted_dashboard_create`
890
+ - **Path params**: None
891
+ - **Query params**: `format`
892
+ - **Response codes**: `200`
893
+ - **Transport options**: None
894
+ - **TypeScript**: [Client interface](../types.ts)
895
+
896
+ **Inputs**
897
+
898
+ - Client input type: `{ [key: string]: unknown }`
899
+ - Client transport options: None
900
+
901
+ **Outputs**
902
+
903
+ - Client return type: `unknown`
904
+ - OpenAPI response codes: `200`
905
+
906
+ ```ts
907
+ import posthog from "@utdk/posthog";
908
+
909
+ type EnvironmentsDashboardsCreateUnlistedDashboardCreateInput = Parameters<typeof posthog.environmentsDashboardsCreateUnlistedDashboardCreate> extends [infer T, ...unknown[]] ? T : undefined;
910
+ type EnvironmentsDashboardsCreateUnlistedDashboardCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsCreateUnlistedDashboardCreate>>;
911
+
912
+ const result: EnvironmentsDashboardsCreateUnlistedDashboardCreateOutput = await posthog.environmentsDashboardsCreateUnlistedDashboardCreate();
913
+
914
+ // Result shape (from schema): unknown
915
+ ```
916
+
917
+ ### `posthog.environmentsDashboardsWidgetCatalogRetrieve`
918
+
919
+ - **HTTP**: `GET /api/environments/{environment_id}/dashboards/widget_catalog/`
920
+ - **What it does**: List registered dashboard widget types and per-type config_schema documentation for agents.
921
+ - **OpenAPI operationId**: `environments_dashboards_widget_catalog_retrieve`
922
+ - **Path params**: None
923
+ - **Query params**: `format`
924
+ - **Response codes**: `200`
925
+ - **Transport options**: None
926
+ - **TypeScript**: [Client interface](../types.ts)
927
+
928
+ **Inputs**
929
+
930
+ - Client input type: `{ [key: string]: unknown }`
931
+ - Client transport options: None
932
+
933
+ **Outputs**
934
+
935
+ - Client return type: `{ results: ({ widget_type: "activity_events_list"; group_id: string; group_label: string; label: string; description: string; config_schema: { dateRange?: { date_from?: "-1M" | "-30M" | "-1h" | "-3h" | "-24h" | "-7d" | ...`
936
+ - OpenAPI response codes: `200`
937
+
938
+ ```ts
939
+ import posthog from "@utdk/posthog";
940
+
941
+ type EnvironmentsDashboardsWidgetCatalogRetrieveInput = Parameters<typeof posthog.environmentsDashboardsWidgetCatalogRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
942
+ type EnvironmentsDashboardsWidgetCatalogRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDashboardsWidgetCatalogRetrieve>>;
943
+
944
+ const result: EnvironmentsDashboardsWidgetCatalogRetrieveOutput = await posthog.environmentsDashboardsWidgetCatalogRetrieve();
945
+
946
+ // Result shape (from schema): { results: ({ widget_type: "activity_events_list"; group_id: string; group_label: string; label: string; description: string; config_schema: { dateRange?: { date_from?: "-1M" | "-30M" | "-1h" | "-3h" | "-24h" | "-7d" | ...
947
+ ```
948
+
949
+ ### `posthog.dashboardsList`
950
+
951
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/`
952
+ - **OpenAPI operationId**: `dashboards_list`
953
+ - **Path params**: None
954
+ - **Query params**: `folder`, `format`, `limit`, `offset`, `search`
955
+ - **Response codes**: `200`
956
+ - **Transport options**: None
957
+ - **TypeScript**: [Client interface](../types.ts)
958
+
959
+ **Inputs**
960
+
961
+ - Client input type: `{ [key: string]: unknown }`
962
+ - Client transport options: None
963
+
964
+ **Outputs**
965
+
966
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string | null; description: string; pinned: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id...`
967
+ - OpenAPI response codes: `200`
968
+
969
+ ```ts
970
+ import posthog from "@utdk/posthog";
971
+
972
+ type DashboardsListInput = Parameters<typeof posthog.dashboardsList> extends [infer T, ...unknown[]] ? T : undefined;
973
+ type DashboardsListOutput = Awaited<ReturnType<typeof posthog.dashboardsList>>;
974
+
975
+ const result: DashboardsListOutput = await posthog.dashboardsList();
976
+
977
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string | null; description: string; pinned: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id...
978
+ ```
979
+
980
+ ### `posthog.dashboardsCreate`
981
+
982
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/`
983
+ - **OpenAPI operationId**: `dashboards_create`
984
+ - **Path params**: None
985
+ - **Query params**: `format`
986
+ - **Response codes**: `201`
987
+ - **Transport options**: None
988
+ - **TypeScript**: [Client interface](../types.ts)
989
+
990
+ **Inputs**
991
+
992
+ - Client input type: `{ [key: string]: unknown }`
993
+ - Client transport options: None
994
+
995
+ **Outputs**
996
+
997
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
998
+ - OpenAPI response codes: `201`
999
+
1000
+ ```ts
1001
+ import posthog from "@utdk/posthog";
1002
+
1003
+ type DashboardsCreateInput = Parameters<typeof posthog.dashboardsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1004
+ type DashboardsCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCreate>>;
1005
+
1006
+ const result: DashboardsCreateOutput = await posthog.dashboardsCreate();
1007
+
1008
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1009
+ ```
1010
+
1011
+ ### `posthog.dashboardsCollaboratorsList`
1012
+
1013
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/`
1014
+ - **OpenAPI operationId**: `dashboards_collaborators_list`
1015
+ - **Path params**: `dashboard_id`
1016
+ - **Query params**: None
1017
+ - **Response codes**: `200`
1018
+ - **Transport options**: None
1019
+ - **TypeScript**: [Client interface](../types.ts)
1020
+
1021
+ **Inputs**
1022
+
1023
+ - Client input type: `{ [key: string]: unknown }`
1024
+ - Client transport options: None
1025
+
1026
+ **Outputs**
1027
+
1028
+ - Client return type: `({ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: st...`
1029
+ - OpenAPI response codes: `200`
1030
+
1031
+ ```ts
1032
+ import posthog from "@utdk/posthog";
1033
+
1034
+ type DashboardsCollaboratorsListInput = Parameters<typeof posthog.dashboardsCollaboratorsList> extends [infer T, ...unknown[]] ? T : undefined;
1035
+ type DashboardsCollaboratorsListOutput = Awaited<ReturnType<typeof posthog.dashboardsCollaboratorsList>>;
1036
+
1037
+ const result: DashboardsCollaboratorsListOutput = await posthog.dashboardsCollaboratorsList();
1038
+
1039
+ // Result shape (from schema): ({ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: st...
1040
+ ```
1041
+
1042
+ ### `posthog.dashboardsCollaboratorsCreate`
1043
+
1044
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/`
1045
+ - **OpenAPI operationId**: `dashboards_collaborators_create`
1046
+ - **Path params**: `dashboard_id`
1047
+ - **Query params**: None
1048
+ - **Response codes**: `201`
1049
+ - **Transport options**: None
1050
+ - **TypeScript**: [Client interface](../types.ts)
1051
+
1052
+ **Inputs**
1053
+
1054
+ - Client input type: `{ [key: string]: unknown }`
1055
+ - Client transport options: None
1056
+
1057
+ **Outputs**
1058
+
1059
+ - Client return type: `{ id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: str...`
1060
+ - OpenAPI response codes: `201`
1061
+
1062
+ ```ts
1063
+ import posthog from "@utdk/posthog";
1064
+
1065
+ type DashboardsCollaboratorsCreateInput = Parameters<typeof posthog.dashboardsCollaboratorsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1066
+ type DashboardsCollaboratorsCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCollaboratorsCreate>>;
1067
+
1068
+ const result: DashboardsCollaboratorsCreateOutput = await posthog.dashboardsCollaboratorsCreate();
1069
+
1070
+ // Result shape (from schema): { id: string; dashboard_id: number; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: str...
1071
+ ```
1072
+
1073
+ ### `posthog.dashboardsCollaboratorsDestroy`
1074
+
1075
+ - **HTTP**: `DELETE /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/`
1076
+ - **OpenAPI operationId**: `dashboards_collaborators_destroy`
1077
+ - **Path params**: `dashboard_id`, `user__uuid`
1078
+ - **Query params**: None
1079
+ - **Response codes**: `204`
1080
+ - **Transport options**: None
1081
+ - **TypeScript**: [Client interface](../types.ts)
1082
+
1083
+ **Inputs**
1084
+
1085
+ - Client input type: `{ [key: string]: unknown }`
1086
+ - Client transport options: None
1087
+
1088
+ **Outputs**
1089
+
1090
+ - Client return type: `unknown`
1091
+ - OpenAPI response codes: `204`
1092
+
1093
+ ```ts
1094
+ import posthog from "@utdk/posthog";
1095
+
1096
+ type DashboardsCollaboratorsDestroyInput = Parameters<typeof posthog.dashboardsCollaboratorsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
1097
+ type DashboardsCollaboratorsDestroyOutput = Awaited<ReturnType<typeof posthog.dashboardsCollaboratorsDestroy>>;
1098
+
1099
+ const result: DashboardsCollaboratorsDestroyOutput = await posthog.dashboardsCollaboratorsDestroy();
1100
+
1101
+ // Result shape (from schema): unknown
1102
+ ```
1103
+
1104
+ ### `posthog.dashboardsSharingList`
1105
+
1106
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/`
1107
+ - **OpenAPI operationId**: `dashboards_sharing_list`
1108
+ - **Path params**: `dashboard_id`
1109
+ - **Query params**: None
1110
+ - **Response codes**: `200`
1111
+ - **Transport options**: None
1112
+ - **TypeScript**: [Client interface](../types.ts)
1113
+
1114
+ **Inputs**
1115
+
1116
+ - Client input type: `{ [key: string]: unknown }`
1117
+ - Client transport options: None
1118
+
1119
+ **Outputs**
1120
+
1121
+ - Client return type: `({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...`
1122
+ - OpenAPI response codes: `200`
1123
+
1124
+ ```ts
1125
+ import posthog from "@utdk/posthog";
1126
+
1127
+ type DashboardsSharingListInput = Parameters<typeof posthog.dashboardsSharingList> extends [infer T, ...unknown[]] ? T : undefined;
1128
+ type DashboardsSharingListOutput = Awaited<ReturnType<typeof posthog.dashboardsSharingList>>;
1129
+
1130
+ const result: DashboardsSharingListOutput = await posthog.dashboardsSharingList();
1131
+
1132
+ // Result shape (from schema): ({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...
1133
+ ```
1134
+
1135
+ ### `posthog.dashboardsSharingPasswordsCreate`
1136
+
1137
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/`
1138
+ - **What it does**: Create a new password for the sharing configuration.
1139
+ - **OpenAPI operationId**: `dashboards_sharing_passwords_create`
1140
+ - **Path params**: `dashboard_id`
1141
+ - **Query params**: None
1142
+ - **Response codes**: `200`
1143
+ - **Transport options**: None
1144
+ - **TypeScript**: [Client interface](../types.ts)
1145
+
1146
+ **Inputs**
1147
+
1148
+ - Client input type: `{ [key: string]: unknown }`
1149
+ - Client transport options: None
1150
+
1151
+ **Outputs**
1152
+
1153
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
1154
+ - OpenAPI response codes: `200`
1155
+
1156
+ ```ts
1157
+ import posthog from "@utdk/posthog";
1158
+
1159
+ type DashboardsSharingPasswordsCreateInput = Parameters<typeof posthog.dashboardsSharingPasswordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1160
+ type DashboardsSharingPasswordsCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsSharingPasswordsCreate>>;
1161
+
1162
+ const result: DashboardsSharingPasswordsCreateOutput = await posthog.dashboardsSharingPasswordsCreate();
1163
+
1164
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
1165
+ ```
1166
+
1167
+ ### `posthog.dashboardsSharingPasswordsDestroy`
1168
+
1169
+ - **HTTP**: `DELETE /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/`
1170
+ - **What it does**: Delete a password from the sharing configuration.
1171
+ - **OpenAPI operationId**: `dashboards_sharing_passwords_destroy`
1172
+ - **Path params**: `dashboard_id`, `password_id`
1173
+ - **Query params**: None
1174
+ - **Response codes**: `204`
1175
+ - **Transport options**: None
1176
+ - **TypeScript**: [Client interface](../types.ts)
1177
+
1178
+ **Inputs**
1179
+
1180
+ - Client input type: `{ [key: string]: unknown }`
1181
+ - Client transport options: None
1182
+
1183
+ **Outputs**
1184
+
1185
+ - Client return type: `unknown`
1186
+ - OpenAPI response codes: `204`
1187
+
1188
+ ```ts
1189
+ import posthog from "@utdk/posthog";
1190
+
1191
+ type DashboardsSharingPasswordsDestroyInput = Parameters<typeof posthog.dashboardsSharingPasswordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
1192
+ type DashboardsSharingPasswordsDestroyOutput = Awaited<ReturnType<typeof posthog.dashboardsSharingPasswordsDestroy>>;
1193
+
1194
+ const result: DashboardsSharingPasswordsDestroyOutput = await posthog.dashboardsSharingPasswordsDestroy();
1195
+
1196
+ // Result shape (from schema): unknown
1197
+ ```
1198
+
1199
+ ### `posthog.dashboardsSharingRefreshCreate`
1200
+
1201
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/refresh/`
1202
+ - **OpenAPI operationId**: `dashboards_sharing_refresh_create`
1203
+ - **Path params**: `dashboard_id`
1204
+ - **Query params**: None
1205
+ - **Response codes**: `200`
1206
+ - **Transport options**: None
1207
+ - **TypeScript**: [Client interface](../types.ts)
1208
+
1209
+ **Inputs**
1210
+
1211
+ - Client input type: `{ [key: string]: unknown }`
1212
+ - Client transport options: None
1213
+
1214
+ **Outputs**
1215
+
1216
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
1217
+ - OpenAPI response codes: `200`
1218
+
1219
+ ```ts
1220
+ import posthog from "@utdk/posthog";
1221
+
1222
+ type DashboardsSharingRefreshCreateInput = Parameters<typeof posthog.dashboardsSharingRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
1223
+ type DashboardsSharingRefreshCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsSharingRefreshCreate>>;
1224
+
1225
+ const result: DashboardsSharingRefreshCreateOutput = await posthog.dashboardsSharingRefreshCreate();
1226
+
1227
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
1228
+ ```
1229
+
1230
+ ### `posthog.dashboardsDestroy`
1231
+
1232
+ - **HTTP**: `DELETE /api/projects/{project_id}/dashboards/{id}/`
1233
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
1234
+ - **OpenAPI operationId**: `dashboards_destroy`
1235
+ - **Path params**: `id`
1236
+ - **Query params**: `format`
1237
+ - **Response codes**: `405`
1238
+ - **Transport options**: None
1239
+ - **TypeScript**: [Client interface](../types.ts)
1240
+
1241
+ **Inputs**
1242
+
1243
+ - Client input type: `{ [key: string]: unknown }`
1244
+ - Client transport options: None
1245
+
1246
+ **Outputs**
1247
+
1248
+ - Client return type: `unknown`
1249
+ - OpenAPI response codes: `405`
1250
+
1251
+ ```ts
1252
+ import posthog from "@utdk/posthog";
1253
+
1254
+ type DashboardsDestroyInput = Parameters<typeof posthog.dashboardsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
1255
+ type DashboardsDestroyOutput = Awaited<ReturnType<typeof posthog.dashboardsDestroy>>;
1256
+
1257
+ const result: DashboardsDestroyOutput = await posthog.dashboardsDestroy();
1258
+
1259
+ // Result shape (from schema): unknown
1260
+ ```
1261
+
1262
+ ### `posthog.dashboardsRetrieve`
1263
+
1264
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{id}/`
1265
+ - **OpenAPI operationId**: `dashboards_retrieve`
1266
+ - **Path params**: `id`
1267
+ - **Query params**: `filters_override`, `format`, `variables_override`
1268
+ - **Response codes**: `200`
1269
+ - **Transport options**: None
1270
+ - **TypeScript**: [Client interface](../types.ts)
1271
+
1272
+ **Inputs**
1273
+
1274
+ - Client input type: `{ [key: string]: unknown }`
1275
+ - Client transport options: None
1276
+
1277
+ **Outputs**
1278
+
1279
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1280
+ - OpenAPI response codes: `200`
1281
+
1282
+ ```ts
1283
+ import posthog from "@utdk/posthog";
1284
+
1285
+ type DashboardsRetrieveInput = Parameters<typeof posthog.dashboardsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1286
+ type DashboardsRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardsRetrieve>>;
1287
+
1288
+ const result: DashboardsRetrieveOutput = await posthog.dashboardsRetrieve();
1289
+
1290
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1291
+ ```
1292
+
1293
+ ### `posthog.dashboardsPartialUpdate`
1294
+
1295
+ - **HTTP**: `PATCH /api/projects/{project_id}/dashboards/{id}/`
1296
+ - **OpenAPI operationId**: `dashboards_partial_update`
1297
+ - **Path params**: `id`
1298
+ - **Query params**: `format`
1299
+ - **Response codes**: `200`
1300
+ - **Transport options**: None
1301
+ - **TypeScript**: [Client interface](../types.ts)
1302
+
1303
+ **Inputs**
1304
+
1305
+ - Client input type: `{ [key: string]: unknown }`
1306
+ - Client transport options: None
1307
+
1308
+ **Outputs**
1309
+
1310
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1311
+ - OpenAPI response codes: `200`
1312
+
1313
+ ```ts
1314
+ import posthog from "@utdk/posthog";
1315
+
1316
+ type DashboardsPartialUpdateInput = Parameters<typeof posthog.dashboardsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1317
+ type DashboardsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.dashboardsPartialUpdate>>;
1318
+
1319
+ const result: DashboardsPartialUpdateOutput = await posthog.dashboardsPartialUpdate();
1320
+
1321
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1322
+ ```
1323
+
1324
+ ### `posthog.dashboardsUpdate`
1325
+
1326
+ - **HTTP**: `PUT /api/projects/{project_id}/dashboards/{id}/`
1327
+ - **OpenAPI operationId**: `dashboards_update`
1328
+ - **Path params**: `id`
1329
+ - **Query params**: `format`
1330
+ - **Response codes**: `200`
1331
+ - **Transport options**: None
1332
+ - **TypeScript**: [Client interface](../types.ts)
1333
+
1334
+ **Inputs**
1335
+
1336
+ - Client input type: `{ [key: string]: unknown }`
1337
+ - Client transport options: None
1338
+
1339
+ **Outputs**
1340
+
1341
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1342
+ - OpenAPI response codes: `200`
1343
+
1344
+ ```ts
1345
+ import posthog from "@utdk/posthog";
1346
+
1347
+ type DashboardsUpdateInput = Parameters<typeof posthog.dashboardsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1348
+ type DashboardsUpdateOutput = Awaited<ReturnType<typeof posthog.dashboardsUpdate>>;
1349
+
1350
+ const result: DashboardsUpdateOutput = await posthog.dashboardsUpdate();
1351
+
1352
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1353
+ ```
1354
+
1355
+ ### `posthog.dashboardsCopyTileCreate`
1356
+
1357
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/copy_tile/`
1358
+ - **What it does**: Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).
1359
+ - **OpenAPI operationId**: `dashboards_copy_tile_create`
1360
+ - **Path params**: `id`
1361
+ - **Query params**: `format`
1362
+ - **Response codes**: `200`
1363
+ - **Transport options**: None
1364
+ - **TypeScript**: [Client interface](../types.ts)
1365
+
1366
+ **Inputs**
1367
+
1368
+ - Client input type: `{ [key: string]: unknown }`
1369
+ - Client transport options: None
1370
+
1371
+ **Outputs**
1372
+
1373
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1374
+ - OpenAPI response codes: `200`
1375
+
1376
+ ```ts
1377
+ import posthog from "@utdk/posthog";
1378
+
1379
+ type DashboardsCopyTileCreateInput = Parameters<typeof posthog.dashboardsCopyTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
1380
+ type DashboardsCopyTileCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCopyTileCreate>>;
1381
+
1382
+ const result: DashboardsCopyTileCreateOutput = await posthog.dashboardsCopyTileCreate();
1383
+
1384
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1385
+ ```
1386
+
1387
+ ### `posthog.dashboardsCreateTextTileCreate`
1388
+
1389
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/create_text_tile/`
1390
+ - **What it does**: Add a markdown text tile to a dashboard.
1391
+
1392
+ Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers,
1393
+ or annotations between insight tiles to give the dashboard structure.
1394
+ - **OpenAPI operationId**: `dashboards_create_text_tile_create`
1395
+ - **Path params**: `id`
1396
+ - **Query params**: `format`
1397
+ - **Response codes**: `201`
1398
+ - **Transport options**: None
1399
+ - **TypeScript**: [Client interface](../types.ts)
1400
+
1401
+ **Inputs**
1402
+
1403
+ - Client input type: `{ [key: string]: unknown }`
1404
+ - Client transport options: None
1405
+
1406
+ **Outputs**
1407
+
1408
+ - Client return type: `{ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...`
1409
+ - OpenAPI response codes: `201`
1410
+
1411
+ ```ts
1412
+ import posthog from "@utdk/posthog";
1413
+
1414
+ type DashboardsCreateTextTileCreateInput = Parameters<typeof posthog.dashboardsCreateTextTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
1415
+ type DashboardsCreateTextTileCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCreateTextTileCreate>>;
1416
+
1417
+ const result: DashboardsCreateTextTileCreateOutput = await posthog.dashboardsCreateTextTileCreate();
1418
+
1419
+ // Result shape (from schema): { id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...
1420
+ ```
1421
+
1422
+ ### `posthog.dashboardsDeleteTile`
1423
+
1424
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/delete_tile/`
1425
+ - **What it does**: Soft-delete a single tile from a dashboard.
1426
+
1427
+ Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile
1428
+ object is preserved — only the dashboard tile is hidden. To delete the entire dashboard,
1429
+ use the dashboard delete endpoint instead.
1430
+ - **OpenAPI operationId**: `dashboards_delete_tile`
1431
+ - **Path params**: `id`
1432
+ - **Query params**: `format`
1433
+ - **Response codes**: `204`
1434
+ - **Transport options**: None
1435
+ - **TypeScript**: [Client interface](../types.ts)
1436
+
1437
+ **Inputs**
1438
+
1439
+ - Client input type: `{ [key: string]: unknown }`
1440
+ - Client transport options: None
1441
+
1442
+ **Outputs**
1443
+
1444
+ - Client return type: `unknown`
1445
+ - OpenAPI response codes: `204`
1446
+
1447
+ ```ts
1448
+ import posthog from "@utdk/posthog";
1449
+
1450
+ type DashboardsDeleteTileInput = Parameters<typeof posthog.dashboardsDeleteTile> extends [infer T, ...unknown[]] ? T : undefined;
1451
+ type DashboardsDeleteTileOutput = Awaited<ReturnType<typeof posthog.dashboardsDeleteTile>>;
1452
+
1453
+ const result: DashboardsDeleteTileOutput = await posthog.dashboardsDeleteTile();
1454
+
1455
+ // Result shape (from schema): unknown
1456
+ ```
1457
+
1458
+ ### `posthog.dashboardsMoveTilePartialUpdate`
1459
+
1460
+ - **HTTP**: `PATCH /api/projects/{project_id}/dashboards/{id}/move_tile/`
1461
+ - **OpenAPI operationId**: `dashboards_move_tile_partial_update`
1462
+ - **Path params**: `id`
1463
+ - **Query params**: `format`
1464
+ - **Response codes**: `200`
1465
+ - **Transport options**: None
1466
+ - **TypeScript**: [Client interface](../types.ts)
1467
+
1468
+ **Inputs**
1469
+
1470
+ - Client input type: `{ [key: string]: unknown }`
1471
+ - Client transport options: None
1472
+
1473
+ **Outputs**
1474
+
1475
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1476
+ - OpenAPI response codes: `200`
1477
+
1478
+ ```ts
1479
+ import posthog from "@utdk/posthog";
1480
+
1481
+ type DashboardsMoveTilePartialUpdateInput = Parameters<typeof posthog.dashboardsMoveTilePartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1482
+ type DashboardsMoveTilePartialUpdateOutput = Awaited<ReturnType<typeof posthog.dashboardsMoveTilePartialUpdate>>;
1483
+
1484
+ const result: DashboardsMoveTilePartialUpdateOutput = await posthog.dashboardsMoveTilePartialUpdate();
1485
+
1486
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1487
+ ```
1488
+
1489
+ ### `posthog.dashboardsMoveTileCreate`
1490
+
1491
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/move_tile/`
1492
+ - **OpenAPI operationId**: `dashboards_move_tile_create`
1493
+ - **Path params**: `id`
1494
+ - **Query params**: `format`
1495
+ - **Response codes**: `200`
1496
+ - **Transport options**: None
1497
+ - **TypeScript**: [Client interface](../types.ts)
1498
+
1499
+ **Inputs**
1500
+
1501
+ - Client input type: `{ [key: string]: unknown }`
1502
+ - Client transport options: None
1503
+
1504
+ **Outputs**
1505
+
1506
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1507
+ - OpenAPI response codes: `200`
1508
+
1509
+ ```ts
1510
+ import posthog from "@utdk/posthog";
1511
+
1512
+ type DashboardsMoveTileCreateInput = Parameters<typeof posthog.dashboardsMoveTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
1513
+ type DashboardsMoveTileCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsMoveTileCreate>>;
1514
+
1515
+ const result: DashboardsMoveTileCreateOutput = await posthog.dashboardsMoveTileCreate();
1516
+
1517
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1518
+ ```
1519
+
1520
+ ### `posthog.dashboardsReorderTilesCreate`
1521
+
1522
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/reorder_tiles/`
1523
+ - **OpenAPI operationId**: `dashboards_reorder_tiles_create`
1524
+ - **Path params**: `id`
1525
+ - **Query params**: `format`
1526
+ - **Response codes**: `200`
1527
+ - **Transport options**: None
1528
+ - **TypeScript**: [Client interface](../types.ts)
1529
+
1530
+ **Inputs**
1531
+
1532
+ - Client input type: `{ [key: string]: unknown }`
1533
+ - Client transport options: None
1534
+
1535
+ **Outputs**
1536
+
1537
+ - Client return type: `{ id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...`
1538
+ - OpenAPI response codes: `200`
1539
+
1540
+ ```ts
1541
+ import posthog from "@utdk/posthog";
1542
+
1543
+ type DashboardsReorderTilesCreateInput = Parameters<typeof posthog.dashboardsReorderTilesCreate> extends [infer T, ...unknown[]] ? T : undefined;
1544
+ type DashboardsReorderTilesCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsReorderTilesCreate>>;
1545
+
1546
+ const result: DashboardsReorderTilesCreateOutput = await posthog.dashboardsReorderTilesCreate();
1547
+
1548
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string...
1549
+ ```
1550
+
1551
+ ### `posthog.dashboardsRunInsightsRetrieve`
1552
+
1553
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{id}/run_insights/`
1554
+ - **What it does**: Run all insights on a dashboard and return their results.
1555
+ - **OpenAPI operationId**: `dashboards_run_insights_retrieve`
1556
+ - **Path params**: `id`
1557
+ - **Query params**: `filters_override`, `format`, `output_format`, `refresh`, `variables_override`
1558
+ - **Response codes**: `200`
1559
+ - **Transport options**: None
1560
+ - **TypeScript**: [Client interface](../types.ts)
1561
+
1562
+ **Inputs**
1563
+
1564
+ - Client input type: `{ [key: string]: unknown }`
1565
+ - Client transport options: None
1566
+
1567
+ **Outputs**
1568
+
1569
+ - Client return type: `{ results: ({ id?: number; insight: { id: number; short_id: string; name: string | null; derived_name: string | null; result: unknown } })[] }`
1570
+ - OpenAPI response codes: `200`
1571
+
1572
+ ```ts
1573
+ import posthog from "@utdk/posthog";
1574
+
1575
+ type DashboardsRunInsightsRetrieveInput = Parameters<typeof posthog.dashboardsRunInsightsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1576
+ type DashboardsRunInsightsRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardsRunInsightsRetrieve>>;
1577
+
1578
+ const result: DashboardsRunInsightsRetrieveOutput = await posthog.dashboardsRunInsightsRetrieve();
1579
+
1580
+ // Result shape (from schema): { results: ({ id?: number; insight: { id: number; short_id: string; name: string | null; derived_name: string | null; result: unknown } })[] }
1581
+ ```
1582
+
1583
+ ### `posthog.dashboardsRunWidgetsRetrieve`
1584
+
1585
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{id}/run_widgets/`
1586
+ - **OpenAPI operationId**: `dashboards_run_widgets_retrieve`
1587
+ - **Path params**: `id`
1588
+ - **Query params**: `format`, `tile_ids`
1589
+ - **Response codes**: `200`
1590
+ - **Transport options**: None
1591
+ - **TypeScript**: [Client interface](../types.ts)
1592
+
1593
+ **Inputs**
1594
+
1595
+ - Client input type: `{ [key: string]: unknown }`
1596
+ - Client transport options: None
1597
+
1598
+ **Outputs**
1599
+
1600
+ - Client return type: `{ results: ({ tile_id: number; widget_type: string | null; result: unknown; error: string | null })[] }`
1601
+ - OpenAPI response codes: `200`
1602
+
1603
+ ```ts
1604
+ import posthog from "@utdk/posthog";
1605
+
1606
+ type DashboardsRunWidgetsRetrieveInput = Parameters<typeof posthog.dashboardsRunWidgetsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1607
+ type DashboardsRunWidgetsRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardsRunWidgetsRetrieve>>;
1608
+
1609
+ const result: DashboardsRunWidgetsRetrieveOutput = await posthog.dashboardsRunWidgetsRetrieve();
1610
+
1611
+ // Result shape (from schema): { results: ({ tile_id: number; widget_type: string | null; result: unknown; error: string | null })[] }
1612
+ ```
1613
+
1614
+ ### `posthog.dashboardsStreamTilesRetrieve`
1615
+
1616
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/{id}/stream_tiles/`
1617
+ - **What it does**: Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
1618
+ - **OpenAPI operationId**: `dashboards_stream_tiles_retrieve`
1619
+ - **Path params**: `id`
1620
+ - **Query params**: `filters_override`, `format`, `layoutSize`, `variables_override`
1621
+ - **Response codes**: `200`
1622
+ - **Transport options**: None
1623
+ - **TypeScript**: [Client interface](../types.ts)
1624
+
1625
+ **Inputs**
1626
+
1627
+ - Client input type: `{ [key: string]: unknown }`
1628
+ - Client transport options: None
1629
+
1630
+ **Outputs**
1631
+
1632
+ - Client return type: `unknown`
1633
+ - OpenAPI response codes: `200`
1634
+
1635
+ ```ts
1636
+ import posthog from "@utdk/posthog";
1637
+
1638
+ type DashboardsStreamTilesRetrieveInput = Parameters<typeof posthog.dashboardsStreamTilesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1639
+ type DashboardsStreamTilesRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardsStreamTilesRetrieve>>;
1640
+
1641
+ const result: DashboardsStreamTilesRetrieveOutput = await posthog.dashboardsStreamTilesRetrieve();
1642
+
1643
+ // Result shape (from schema): unknown
1644
+ ```
1645
+
1646
+ ### `posthog.dashboardsUpdateTextTileCreate`
1647
+
1648
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/update_text_tile/`
1649
+ - **What it does**: Update the markdown body, layout, or color of an existing text tile on a dashboard.
1650
+ - **OpenAPI operationId**: `dashboards_update_text_tile_create`
1651
+ - **Path params**: `id`
1652
+ - **Query params**: `format`
1653
+ - **Response codes**: `200`
1654
+ - **Transport options**: None
1655
+ - **TypeScript**: [Client interface](../types.ts)
1656
+
1657
+ **Inputs**
1658
+
1659
+ - Client input type: `{ [key: string]: unknown }`
1660
+ - Client transport options: None
1661
+
1662
+ **Outputs**
1663
+
1664
+ - Client return type: `{ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...`
1665
+ - OpenAPI response codes: `200`
1666
+
1667
+ ```ts
1668
+ import posthog from "@utdk/posthog";
1669
+
1670
+ type DashboardsUpdateTextTileCreateInput = Parameters<typeof posthog.dashboardsUpdateTextTileCreate> extends [infer T, ...unknown[]] ? T : undefined;
1671
+ type DashboardsUpdateTextTileCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsUpdateTextTileCreate>>;
1672
+
1673
+ const result: DashboardsUpdateTextTileCreateOutput = await posthog.dashboardsUpdateTextTileCreate();
1674
+
1675
+ // Result shape (from schema): { id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTooltipOnScr...
1676
+ ```
1677
+
1678
+ ### `posthog.dashboardsUpdateWidgetsBatch`
1679
+
1680
+ - **HTTP**: `PATCH /api/projects/{project_id}/dashboards/{id}/widgets/batch_update/`
1681
+ - **What it does**: Update the settings of existing widgets in place, atomically — config, name, and description.
1682
+
1683
+ Each entry targets a widget by its tile_id and reuses the same write path as the dashboard PATCH endpoint.
1684
+ The widget_type is immutable. This edits widget settings only (config, name, description); tile placement
1685
+ (layouts, show_description) is a dashboard concern — use the dashboard PATCH endpoint or reorder_tiles for
1686
+ that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to
1687
+ remove one, use delete_tile.
1688
+ - **OpenAPI operationId**: `dashboards_update_widgets_batch`
1689
+ - **Path params**: `id`
1690
+ - **Query params**: `format`
1691
+ - **Response codes**: `200`
1692
+ - **Transport options**: None
1693
+ - **TypeScript**: [Client interface](../types.ts)
1694
+
1695
+ **Inputs**
1696
+
1697
+ - Client input type: `{ [key: string]: unknown }`
1698
+ - Client transport options: None
1699
+
1700
+ **Outputs**
1701
+
1702
+ - Client return type: `{ tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...`
1703
+ - OpenAPI response codes: `200`
1704
+
1705
+ ```ts
1706
+ import posthog from "@utdk/posthog";
1707
+
1708
+ type DashboardsUpdateWidgetsBatchInput = Parameters<typeof posthog.dashboardsUpdateWidgetsBatch> extends [infer T, ...unknown[]] ? T : undefined;
1709
+ type DashboardsUpdateWidgetsBatchOutput = Awaited<ReturnType<typeof posthog.dashboardsUpdateWidgetsBatch>>;
1710
+
1711
+ const result: DashboardsUpdateWidgetsBatchOutput = await posthog.dashboardsUpdateWidgetsBatch();
1712
+
1713
+ // Result shape (from schema): { tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...
1714
+ ```
1715
+
1716
+ ### `posthog.dashboardsWidgetsBatchCreate`
1717
+
1718
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/{id}/widgets/batch/`
1719
+ - **What it does**: Add multiple widget tiles to a dashboard in one atomic request.
1720
+ - **OpenAPI operationId**: `dashboards_widgets_batch_create`
1721
+ - **Path params**: `id`
1722
+ - **Query params**: `format`
1723
+ - **Response codes**: `201`
1724
+ - **Transport options**: None
1725
+ - **TypeScript**: [Client interface](../types.ts)
1726
+
1727
+ **Inputs**
1728
+
1729
+ - Client input type: `{ [key: string]: unknown }`
1730
+ - Client transport options: None
1731
+
1732
+ **Outputs**
1733
+
1734
+ - Client return type: `{ tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...`
1735
+ - OpenAPI response codes: `201`
1736
+
1737
+ ```ts
1738
+ import posthog from "@utdk/posthog";
1739
+
1740
+ type DashboardsWidgetsBatchCreateInput = Parameters<typeof posthog.dashboardsWidgetsBatchCreate> extends [infer T, ...unknown[]] ? T : undefined;
1741
+ type DashboardsWidgetsBatchCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsWidgetsBatchCreate>>;
1742
+
1743
+ const result: DashboardsWidgetsBatchCreateOutput = await posthog.dashboardsWidgetsBatchCreate();
1744
+
1745
+ // Result shape (from schema): { tiles: ({ id?: number; insight: { id: number; short_id: string; name?: string | null; derived_name?: string | null; query?: { embedded?: boolean | null; full?: boolean | null; hidePersonsModal?: boolean | null; hideTo...
1746
+ ```
1747
+
1748
+ ### `posthog.dashboardsBulkUpdateTagsCreate`
1749
+
1750
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/bulk_update_tags/`
1751
+ - **What it does**: Bulk update tags on multiple objects.
1752
+
1753
+ PAT access: this action has no ``required_scopes=`` on the decorator —
1754
+ inheriting viewsets must add ``"bulk_update_tags"`` to their
1755
+ ``scope_object_write_actions`` list to accept personal API keys.
1756
+ Without that opt-in, ``APIScopePermission`` rejects PAT requests with
1757
+ "This action does not support personal API key access". Done per-viewset
1758
+ so granting ``<scope>:write`` for one resource doesn't leak access to
1759
+ sibling resources that share this mixin.
1760
+
1761
+ Accepts:
1762
+ - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}
1763
+
1764
+ Actions:
1765
+ - "add": Add tags to existing tags on each object
1766
+ - "remove": Remove specific tags from each object
1767
+ - "set": Replace all tags on each object with the provided list
1768
+ - **OpenAPI operationId**: `dashboards_bulk_update_tags_create`
1769
+ - **Path params**: None
1770
+ - **Query params**: `format`
1771
+ - **Response codes**: `200`
1772
+ - **Transport options**: None
1773
+ - **TypeScript**: [Client interface](../types.ts)
1774
+
1775
+ **Inputs**
1776
+
1777
+ - Client input type: `{ [key: string]: unknown }`
1778
+ - Client transport options: None
1779
+
1780
+ **Outputs**
1781
+
1782
+ - Client return type: `{ updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }`
1783
+ - OpenAPI response codes: `200`
1784
+
1785
+ ```ts
1786
+ import posthog from "@utdk/posthog";
1787
+
1788
+ type DashboardsBulkUpdateTagsCreateInput = Parameters<typeof posthog.dashboardsBulkUpdateTagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1789
+ type DashboardsBulkUpdateTagsCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsBulkUpdateTagsCreate>>;
1790
+
1791
+ const result: DashboardsBulkUpdateTagsCreateOutput = await posthog.dashboardsBulkUpdateTagsCreate();
1792
+
1793
+ // Result shape (from schema): { updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }
1794
+ ```
1795
+
1796
+ ### `posthog.dashboardsCreateFromTemplateJsonCreate`
1797
+
1798
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/create_from_template_json/`
1799
+ - **OpenAPI operationId**: `dashboards_create_from_template_json_create`
1800
+ - **Path params**: None
1801
+ - **Query params**: `format`
1802
+ - **Response codes**: `200`
1803
+ - **Transport options**: None
1804
+ - **TypeScript**: [Client interface](../types.ts)
1805
+
1806
+ **Inputs**
1807
+
1808
+ - Client input type: `{ [key: string]: unknown }`
1809
+ - Client transport options: None
1810
+
1811
+ **Outputs**
1812
+
1813
+ - Client return type: `unknown`
1814
+ - OpenAPI response codes: `200`
1815
+
1816
+ ```ts
1817
+ import posthog from "@utdk/posthog";
1818
+
1819
+ type DashboardsCreateFromTemplateJsonCreateInput = Parameters<typeof posthog.dashboardsCreateFromTemplateJsonCreate> extends [infer T, ...unknown[]] ? T : undefined;
1820
+ type DashboardsCreateFromTemplateJsonCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCreateFromTemplateJsonCreate>>;
1821
+
1822
+ const result: DashboardsCreateFromTemplateJsonCreateOutput = await posthog.dashboardsCreateFromTemplateJsonCreate();
1823
+
1824
+ // Result shape (from schema): unknown
1825
+ ```
1826
+
1827
+ ### `posthog.dashboardsCreateUnlistedDashboardCreate`
1828
+
1829
+ - **HTTP**: `POST /api/projects/{project_id}/dashboards/create_unlisted_dashboard/`
1830
+ - **What it does**: Creates an unlisted dashboard from template by tag.
1831
+ Enforces uniqueness (one per tag per team).
1832
+ Returns 409 if unlisted dashboard with this tag already exists.
1833
+ - **OpenAPI operationId**: `dashboards_create_unlisted_dashboard_create`
1834
+ - **Path params**: None
1835
+ - **Query params**: `format`
1836
+ - **Response codes**: `200`
1837
+ - **Transport options**: None
1838
+ - **TypeScript**: [Client interface](../types.ts)
1839
+
1840
+ **Inputs**
1841
+
1842
+ - Client input type: `{ [key: string]: unknown }`
1843
+ - Client transport options: None
1844
+
1845
+ **Outputs**
1846
+
1847
+ - Client return type: `unknown`
1848
+ - OpenAPI response codes: `200`
1849
+
1850
+ ```ts
1851
+ import posthog from "@utdk/posthog";
1852
+
1853
+ type DashboardsCreateUnlistedDashboardCreateInput = Parameters<typeof posthog.dashboardsCreateUnlistedDashboardCreate> extends [infer T, ...unknown[]] ? T : undefined;
1854
+ type DashboardsCreateUnlistedDashboardCreateOutput = Awaited<ReturnType<typeof posthog.dashboardsCreateUnlistedDashboardCreate>>;
1855
+
1856
+ const result: DashboardsCreateUnlistedDashboardCreateOutput = await posthog.dashboardsCreateUnlistedDashboardCreate();
1857
+
1858
+ // Result shape (from schema): unknown
1859
+ ```
1860
+
1861
+ ### `posthog.dashboardsWidgetCatalogRetrieve`
1862
+
1863
+ - **HTTP**: `GET /api/projects/{project_id}/dashboards/widget_catalog/`
1864
+ - **What it does**: List registered dashboard widget types and per-type config_schema documentation for agents.
1865
+ - **OpenAPI operationId**: `dashboards_widget_catalog_retrieve`
1866
+ - **Path params**: None
1867
+ - **Query params**: `format`
1868
+ - **Response codes**: `200`
1869
+ - **Transport options**: None
1870
+ - **TypeScript**: [Client interface](../types.ts)
1871
+
1872
+ **Inputs**
1873
+
1874
+ - Client input type: `{ [key: string]: unknown }`
1875
+ - Client transport options: None
1876
+
1877
+ **Outputs**
1878
+
1879
+ - Client return type: `{ results: ({ widget_type: "activity_events_list"; group_id: string; group_label: string; label: string; description: string; config_schema: { dateRange?: { date_from?: "-1M" | "-30M" | "-1h" | "-3h" | "-24h" | "-7d" | ...`
1880
+ - OpenAPI response codes: `200`
1881
+
1882
+ ```ts
1883
+ import posthog from "@utdk/posthog";
1884
+
1885
+ type DashboardsWidgetCatalogRetrieveInput = Parameters<typeof posthog.dashboardsWidgetCatalogRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1886
+ type DashboardsWidgetCatalogRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardsWidgetCatalogRetrieve>>;
1887
+
1888
+ const result: DashboardsWidgetCatalogRetrieveOutput = await posthog.dashboardsWidgetCatalogRetrieve();
1889
+
1890
+ // Result shape (from schema): { results: ({ widget_type: "activity_events_list"; group_id: string; group_label: string; label: string; description: string; config_schema: { dateRange?: { date_from?: "-1M" | "-30M" | "-1h" | "-3h" | "-24h" | "-7d" | ...
1891
+ ```
1892
+
1893
+
1894
+ <!-- prompt-hash:
1895
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
1896
+ -->