@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,731 @@
1
+ # Surveys
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.surveysList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/`
8
+ - **OpenAPI operationId**: `surveys_list`
9
+ - **Path params**: None
10
+ - **Query params**: `archived`, `ids`, `limit`, `offset`, `search`, `type`
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: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag:...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type SurveysListInput = Parameters<typeof posthog.surveysList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type SurveysListOutput = Awaited<ReturnType<typeof posthog.surveysList>>;
30
+
31
+ const result: SurveysListOutput = await posthog.surveysList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag:...
34
+ ```
35
+
36
+ ### `posthog.surveysCreate`
37
+
38
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/`
39
+ - **OpenAPI operationId**: `surveys_create`
40
+ - **Path params**: None
41
+ - **Query params**: None
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: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type SurveysCreateInput = Parameters<typeof posthog.surveysCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type SurveysCreateOutput = Awaited<ReturnType<typeof posthog.surveysCreate>>;
61
+
62
+ const result: SurveysCreateOutput = await posthog.surveysCreate();
63
+
64
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
65
+ ```
66
+
67
+ ### `posthog.surveysDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/projects/{project_id}/surveys/{id}/`
70
+ - **OpenAPI operationId**: `surveys_destroy`
71
+ - **Path params**: `id`
72
+ - **Query params**: None
73
+ - **Response codes**: `204`
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: `unknown`
85
+ - OpenAPI response codes: `204`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type SurveysDestroyInput = Parameters<typeof posthog.surveysDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type SurveysDestroyOutput = Awaited<ReturnType<typeof posthog.surveysDestroy>>;
92
+
93
+ const result: SurveysDestroyOutput = await posthog.surveysDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.surveysRetrieve`
99
+
100
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/{id}/`
101
+ - **OpenAPI operationId**: `surveys_retrieve`
102
+ - **Path params**: `id`
103
+ - **Query params**: None
104
+ - **Response codes**: `200`
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; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type SurveysRetrieveInput = Parameters<typeof posthog.surveysRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type SurveysRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysRetrieve>>;
123
+
124
+ const result: SurveysRetrieveOutput = await posthog.surveysRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
127
+ ```
128
+
129
+ ### `posthog.surveysPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/projects/{project_id}/surveys/{id}/`
132
+ - **OpenAPI operationId**: `surveys_partial_update`
133
+ - **Path params**: `id`
134
+ - **Query params**: None
135
+ - **Response codes**: `200`
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: `{ id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type SurveysPartialUpdateInput = Parameters<typeof posthog.surveysPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type SurveysPartialUpdateOutput = Awaited<ReturnType<typeof posthog.surveysPartialUpdate>>;
154
+
155
+ const result: SurveysPartialUpdateOutput = await posthog.surveysPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
158
+ ```
159
+
160
+ ### `posthog.surveysUpdate`
161
+
162
+ - **HTTP**: `PUT /api/projects/{project_id}/surveys/{id}/`
163
+ - **OpenAPI operationId**: `surveys_update`
164
+ - **Path params**: `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: `{ id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type SurveysUpdateInput = Parameters<typeof posthog.surveysUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type SurveysUpdateOutput = Awaited<ReturnType<typeof posthog.surveysUpdate>>;
185
+
186
+ const result: SurveysUpdateOutput = await posthog.surveysUpdate();
187
+
188
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
189
+ ```
190
+
191
+ ### `posthog.surveysActivityRetrieve`
192
+
193
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/{id}/activity/`
194
+ - **OpenAPI operationId**: `surveys_activity_retrieve`
195
+ - **Path params**: `id`
196
+ - **Query params**: None
197
+ - **Response codes**: `200`
198
+ - **Transport options**: None
199
+ - **TypeScript**: [Client interface](../types.ts)
200
+
201
+ **Inputs**
202
+
203
+ - Client input type: `{ [key: string]: unknown }`
204
+ - Client transport options: None
205
+
206
+ **Outputs**
207
+
208
+ - Client return type: `unknown`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type SurveysActivityRetrieveInput = Parameters<typeof posthog.surveysActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type SurveysActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysActivityRetrieve>>;
216
+
217
+ const result: SurveysActivityRetrieveOutput = await posthog.surveysActivityRetrieve();
218
+
219
+ // Result shape (from schema): unknown
220
+ ```
221
+
222
+ ### `posthog.surveysArchivedResponseUuidsRetrieve`
223
+
224
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/{id}/archived-response-uuids/`
225
+ - **What it does**: Get list of archived response UUIDs for HogQL filtering.
226
+
227
+ Returns list of UUIDs that the frontend can use to filter out archived responses
228
+ in HogQL queries.
229
+ - **OpenAPI operationId**: `surveys_archived_response_uuids_retrieve`
230
+ - **Path params**: `id`
231
+ - **Query params**: None
232
+ - **Response codes**: `200`
233
+ - **Transport options**: None
234
+ - **TypeScript**: [Client interface](../types.ts)
235
+
236
+ **Inputs**
237
+
238
+ - Client input type: `{ [key: string]: unknown }`
239
+ - Client transport options: None
240
+
241
+ **Outputs**
242
+
243
+ - Client return type: `unknown`
244
+ - OpenAPI response codes: `200`
245
+
246
+ ```ts
247
+ import posthog from "@utdk/posthog";
248
+
249
+ type SurveysArchivedResponseUuidsRetrieveInput = Parameters<typeof posthog.surveysArchivedResponseUuidsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
250
+ type SurveysArchivedResponseUuidsRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysArchivedResponseUuidsRetrieve>>;
251
+
252
+ const result: SurveysArchivedResponseUuidsRetrieveOutput = await posthog.surveysArchivedResponseUuidsRetrieve();
253
+
254
+ // Result shape (from schema): unknown
255
+ ```
256
+
257
+ ### `posthog.surveysDuplicateToProjectsCreate`
258
+
259
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/duplicate_to_projects/`
260
+ - **What it does**: Duplicate a survey to multiple projects in a single transaction.
261
+
262
+ Accepts a list of target team IDs and creates a copy of the survey in each project.
263
+ Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.
264
+ - **OpenAPI operationId**: `surveys_duplicate_to_projects_create`
265
+ - **Path params**: `id`
266
+ - **Query params**: None
267
+ - **Response codes**: `200`
268
+ - **Transport options**: None
269
+ - **TypeScript**: [Client interface](../types.ts)
270
+
271
+ **Inputs**
272
+
273
+ - Client input type: `{ [key: string]: unknown }`
274
+ - Client transport options: None
275
+
276
+ **Outputs**
277
+
278
+ - Client return type: `unknown`
279
+ - OpenAPI response codes: `200`
280
+
281
+ ```ts
282
+ import posthog from "@utdk/posthog";
283
+
284
+ type SurveysDuplicateToProjectsCreateInput = Parameters<typeof posthog.surveysDuplicateToProjectsCreate> extends [infer T, ...unknown[]] ? T : undefined;
285
+ type SurveysDuplicateToProjectsCreateOutput = Awaited<ReturnType<typeof posthog.surveysDuplicateToProjectsCreate>>;
286
+
287
+ const result: SurveysDuplicateToProjectsCreateOutput = await posthog.surveysDuplicateToProjectsCreate();
288
+
289
+ // Result shape (from schema): unknown
290
+ ```
291
+
292
+ ### `posthog.surveysGenerateTranslationsCreate`
293
+
294
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/generate_translations/`
295
+ - **OpenAPI operationId**: `surveys_generate_translations_create`
296
+ - **Path params**: `id`
297
+ - **Query params**: None
298
+ - **Response codes**: `200`
299
+ - **Transport options**: None
300
+ - **TypeScript**: [Client interface](../types.ts)
301
+
302
+ **Inputs**
303
+
304
+ - Client input type: `{ [key: string]: unknown }`
305
+ - Client transport options: None
306
+
307
+ **Outputs**
308
+
309
+ - Client return type: `{ translations: { [key: string]: { name?: string; thankYouMessageHeader?: string; thankYouMessageDescription?: string; thankYouMessageCloseButtonText?: string } | undefined }; questions: ({ id: string; translations: { [...`
310
+ - OpenAPI response codes: `200`
311
+
312
+ ```ts
313
+ import posthog from "@utdk/posthog";
314
+
315
+ type SurveysGenerateTranslationsCreateInput = Parameters<typeof posthog.surveysGenerateTranslationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
316
+ type SurveysGenerateTranslationsCreateOutput = Awaited<ReturnType<typeof posthog.surveysGenerateTranslationsCreate>>;
317
+
318
+ const result: SurveysGenerateTranslationsCreateOutput = await posthog.surveysGenerateTranslationsCreate();
319
+
320
+ // Result shape (from schema): { translations: { [key: string]: { name?: string; thankYouMessageHeader?: string; thankYouMessageDescription?: string; thankYouMessageCloseButtonText?: string } | undefined }; questions: ({ id: string; translations: { [...
321
+ ```
322
+
323
+ ### `posthog.surveysLaunch`
324
+
325
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/launch/`
326
+ - **What it does**: Launch a survey by setting `start_date` to the current time. No-op if the survey is already launched (start_date set in the past) — returns the existing state unchanged. Does not affect archived surveys or surveys with an end_date in the past; unarchive or extend the end_date first.
327
+ - **OpenAPI operationId**: `surveys_launch`
328
+ - **Path params**: `id`
329
+ - **Query params**: None
330
+ - **Response codes**: `200`
331
+ - **Transport options**: None
332
+ - **TypeScript**: [Client interface](../types.ts)
333
+
334
+ **Inputs**
335
+
336
+ - Client input type: `{ [key: string]: unknown }`
337
+ - Client transport options: None
338
+
339
+ **Outputs**
340
+
341
+ - Client return type: `{ id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
342
+ - OpenAPI response codes: `200`
343
+
344
+ ```ts
345
+ import posthog from "@utdk/posthog";
346
+
347
+ type SurveysLaunchInput = Parameters<typeof posthog.surveysLaunch> extends [infer T, ...unknown[]] ? T : undefined;
348
+ type SurveysLaunchOutput = Awaited<ReturnType<typeof posthog.surveysLaunch>>;
349
+
350
+ const result: SurveysLaunchOutput = await posthog.surveysLaunch();
351
+
352
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
353
+ ```
354
+
355
+ ### `posthog.surveysResponsesList`
356
+
357
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/{id}/responses/`
358
+ - **What it does**: List survey responses for a specific survey, with question text resolved server-side so callers do not have to map opaque `$survey_response_<id>` keys. Each row carries `distinct_id`, `session_id`, `submitted_at`, and an `extra` block (device, browser, OS, geoip, current_url, iteration) so agents can cross-pivot to recordings, persons, or paths in a single follow-up call. For person properties at event time, follow up with `persons-get` using the returned `distinct_id` — keeps scopes scoped. Use `question_id` + `score_lte` to fetch NPS detractors and similar score-filtered cohorts.
359
+ - **OpenAPI operationId**: `surveys_responses_list`
360
+ - **Path params**: `id`
361
+ - **Query params**: `exclude_archived`, `limit`, `offset`, `question_id`, `score_gte`, `score_lte`, `since`, `until`
362
+ - **Response codes**: `200`
363
+ - **Transport options**: None
364
+ - **TypeScript**: [Client interface](../types.ts)
365
+
366
+ **Inputs**
367
+
368
+ - Client input type: `{ [key: string]: unknown }`
369
+ - Client transport options: None
370
+
371
+ **Outputs**
372
+
373
+ - Client return type: `{ results: ({ uuid: string; distinct_id: string; session_id: string | null; submitted_at: string; answers: ({ question_id: string; question_index: number; question_text: string; question_type: string; answer: unknown })...`
374
+ - OpenAPI response codes: `200`
375
+
376
+ ```ts
377
+ import posthog from "@utdk/posthog";
378
+
379
+ type SurveysResponsesListInput = Parameters<typeof posthog.surveysResponsesList> extends [infer T, ...unknown[]] ? T : undefined;
380
+ type SurveysResponsesListOutput = Awaited<ReturnType<typeof posthog.surveysResponsesList>>;
381
+
382
+ const result: SurveysResponsesListOutput = await posthog.surveysResponsesList();
383
+
384
+ // Result shape (from schema): { results: ({ uuid: string; distinct_id: string; session_id: string | null; submitted_at: string; answers: ({ question_id: string; question_index: number; question_text: string; question_type: string; answer: unknown })...
385
+ ```
386
+
387
+ ### `posthog.surveysResponsesArchiveCreate`
388
+
389
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/responses/{response_uuid}/archive/`
390
+ - **What it does**: Archive a single survey response.
391
+ - **OpenAPI operationId**: `surveys_responses_archive_create`
392
+ - **Path params**: `id`, `response_uuid`
393
+ - **Query params**: None
394
+ - **Response codes**: `200`
395
+ - **Transport options**: None
396
+ - **TypeScript**: [Client interface](../types.ts)
397
+
398
+ **Inputs**
399
+
400
+ - Client input type: `{ [key: string]: unknown }`
401
+ - Client transport options: None
402
+
403
+ **Outputs**
404
+
405
+ - Client return type: `unknown`
406
+ - OpenAPI response codes: `200`
407
+
408
+ ```ts
409
+ import posthog from "@utdk/posthog";
410
+
411
+ type SurveysResponsesArchiveCreateInput = Parameters<typeof posthog.surveysResponsesArchiveCreate> extends [infer T, ...unknown[]] ? T : undefined;
412
+ type SurveysResponsesArchiveCreateOutput = Awaited<ReturnType<typeof posthog.surveysResponsesArchiveCreate>>;
413
+
414
+ const result: SurveysResponsesArchiveCreateOutput = await posthog.surveysResponsesArchiveCreate();
415
+
416
+ // Result shape (from schema): unknown
417
+ ```
418
+
419
+ ### `posthog.surveysResponsesUnarchiveCreate`
420
+
421
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/responses/{response_uuid}/unarchive/`
422
+ - **What it does**: Unarchive a single survey response.
423
+ - **OpenAPI operationId**: `surveys_responses_unarchive_create`
424
+ - **Path params**: `id`, `response_uuid`
425
+ - **Query params**: None
426
+ - **Response codes**: `200`
427
+ - **Transport options**: None
428
+ - **TypeScript**: [Client interface](../types.ts)
429
+
430
+ **Inputs**
431
+
432
+ - Client input type: `{ [key: string]: unknown }`
433
+ - Client transport options: None
434
+
435
+ **Outputs**
436
+
437
+ - Client return type: `unknown`
438
+ - OpenAPI response codes: `200`
439
+
440
+ ```ts
441
+ import posthog from "@utdk/posthog";
442
+
443
+ type SurveysResponsesUnarchiveCreateInput = Parameters<typeof posthog.surveysResponsesUnarchiveCreate> extends [infer T, ...unknown[]] ? T : undefined;
444
+ type SurveysResponsesUnarchiveCreateOutput = Awaited<ReturnType<typeof posthog.surveysResponsesUnarchiveCreate>>;
445
+
446
+ const result: SurveysResponsesUnarchiveCreateOutput = await posthog.surveysResponsesUnarchiveCreate();
447
+
448
+ // Result shape (from schema): unknown
449
+ ```
450
+
451
+ ### `posthog.surveysStatsRetrieve`
452
+
453
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/{id}/stats/`
454
+ - **What it does**: Get survey response statistics for a specific survey.
455
+
456
+ Args:
457
+ date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)
458
+ date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)
459
+ exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)
460
+ include_per_question_stats: Optional boolean to include per-question response counts and distributions
461
+
462
+ Returns:
463
+ Survey statistics including event counts, unique respondents, and conversion rates
464
+ - **OpenAPI operationId**: `surveys_stats_retrieve`
465
+ - **Path params**: `id`
466
+ - **Query params**: `date_from`, `date_to`, `include_per_question_stats`
467
+ - **Response codes**: `200`
468
+ - **Transport options**: None
469
+ - **TypeScript**: [Client interface](../types.ts)
470
+
471
+ **Inputs**
472
+
473
+ - Client input type: `{ [key: string]: unknown }`
474
+ - Client transport options: None
475
+
476
+ **Outputs**
477
+
478
+ - Client return type: `{ survey_id: string; start_date: string | null; end_date: string | null; stats: { [key: string]: unknown }; rates: { [key: string]: unknown }; per_question_stats?: (unknown)[] }`
479
+ - OpenAPI response codes: `200`
480
+
481
+ ```ts
482
+ import posthog from "@utdk/posthog";
483
+
484
+ type SurveysStatsRetrieveInput = Parameters<typeof posthog.surveysStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
485
+ type SurveysStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysStatsRetrieve>>;
486
+
487
+ const result: SurveysStatsRetrieveOutput = await posthog.surveysStatsRetrieve();
488
+
489
+ // Result shape (from schema): { survey_id: string; start_date: string | null; end_date: string | null; stats: { [key: string]: unknown }; rates: { [key: string]: unknown }; per_question_stats?: (unknown)[] }
490
+ ```
491
+
492
+ ### `posthog.surveysStop`
493
+
494
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/stop/`
495
+ - **What it does**: Stop a survey by setting `end_date` to the current time. No new responses are accepted after this; existing responses remain available. No-op if the survey already has an end_date in the past.
496
+ - **OpenAPI operationId**: `surveys_stop`
497
+ - **Path params**: `id`
498
+ - **Query params**: None
499
+ - **Response codes**: `200`
500
+ - **Transport options**: None
501
+ - **TypeScript**: [Client interface](../types.ts)
502
+
503
+ **Inputs**
504
+
505
+ - Client input type: `{ [key: string]: unknown }`
506
+ - Client transport options: None
507
+
508
+ **Outputs**
509
+
510
+ - Client return type: `{ id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...`
511
+ - OpenAPI response codes: `200`
512
+
513
+ ```ts
514
+ import posthog from "@utdk/posthog";
515
+
516
+ type SurveysStopInput = Parameters<typeof posthog.surveysStop> extends [infer T, ...unknown[]] ? T : undefined;
517
+ type SurveysStopOutput = Awaited<ReturnType<typeof posthog.surveysStop>>;
518
+
519
+ const result: SurveysStopOutput = await posthog.surveysStop();
520
+
521
+ // Result shape (from schema): { id: string; name: string; description?: string; type: "popover" | "widget" | "external_survey" | "api"; schedule?: string | null; linked_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [ke...
522
+ ```
523
+
524
+ ### `posthog.surveysSummarizeResponsesCreate`
525
+
526
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/summarize_responses/`
527
+ - **What it does**: Summarize survey responses. When `question_index` or `question_id` is provided, returns a per-question theme summary using cached `survey.question_summaries` when fresh. When neither is provided, returns the survey-wide headline summary (delegates to summary_headline). Pass `force_refresh=true` in the body to bypass caches.
528
+ - **OpenAPI operationId**: `surveys_summarize_responses_create`
529
+ - **Path params**: `id`
530
+ - **Query params**: `question_id`, `question_index`
531
+ - **Response codes**: `200`
532
+ - **Transport options**: None
533
+ - **TypeScript**: [Client interface](../types.ts)
534
+
535
+ **Inputs**
536
+
537
+ - Client input type: `{ [key: string]: unknown }`
538
+ - Client transport options: None
539
+
540
+ **Outputs**
541
+
542
+ - Client return type: `unknown`
543
+ - OpenAPI response codes: `200`
544
+
545
+ ```ts
546
+ import posthog from "@utdk/posthog";
547
+
548
+ type SurveysSummarizeResponsesCreateInput = Parameters<typeof posthog.surveysSummarizeResponsesCreate> extends [infer T, ...unknown[]] ? T : undefined;
549
+ type SurveysSummarizeResponsesCreateOutput = Awaited<ReturnType<typeof posthog.surveysSummarizeResponsesCreate>>;
550
+
551
+ const result: SurveysSummarizeResponsesCreateOutput = await posthog.surveysSummarizeResponsesCreate();
552
+
553
+ // Result shape (from schema): unknown
554
+ ```
555
+
556
+ ### `posthog.surveysSummaryHeadlineCreate`
557
+
558
+ - **HTTP**: `POST /api/projects/{project_id}/surveys/{id}/summary_headline/`
559
+ - **OpenAPI operationId**: `surveys_summary_headline_create`
560
+ - **Path params**: `id`
561
+ - **Query params**: None
562
+ - **Response codes**: `200`
563
+ - **Transport options**: None
564
+ - **TypeScript**: [Client interface](../types.ts)
565
+
566
+ **Inputs**
567
+
568
+ - Client input type: `{ [key: string]: unknown }`
569
+ - Client transport options: None
570
+
571
+ **Outputs**
572
+
573
+ - Client return type: `unknown`
574
+ - OpenAPI response codes: `200`
575
+
576
+ ```ts
577
+ import posthog from "@utdk/posthog";
578
+
579
+ type SurveysSummaryHeadlineCreateInput = Parameters<typeof posthog.surveysSummaryHeadlineCreate> extends [infer T, ...unknown[]] ? T : undefined;
580
+ type SurveysSummaryHeadlineCreateOutput = Awaited<ReturnType<typeof posthog.surveysSummaryHeadlineCreate>>;
581
+
582
+ const result: SurveysSummaryHeadlineCreateOutput = await posthog.surveysSummaryHeadlineCreate();
583
+
584
+ // Result shape (from schema): unknown
585
+ ```
586
+
587
+ ### `posthog.surveysAllActivityRetrieve`
588
+
589
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/activity/`
590
+ - **OpenAPI operationId**: `surveys_all_activity_retrieve`
591
+ - **Path params**: None
592
+ - **Query params**: None
593
+ - **Response codes**: `200`
594
+ - **Transport options**: None
595
+ - **TypeScript**: [Client interface](../types.ts)
596
+
597
+ **Inputs**
598
+
599
+ - Client input type: `{ [key: string]: unknown }`
600
+ - Client transport options: None
601
+
602
+ **Outputs**
603
+
604
+ - Client return type: `unknown`
605
+ - OpenAPI response codes: `200`
606
+
607
+ ```ts
608
+ import posthog from "@utdk/posthog";
609
+
610
+ type SurveysAllActivityRetrieveInput = Parameters<typeof posthog.surveysAllActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
611
+ type SurveysAllActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysAllActivityRetrieve>>;
612
+
613
+ const result: SurveysAllActivityRetrieveOutput = await posthog.surveysAllActivityRetrieve();
614
+
615
+ // Result shape (from schema): unknown
616
+ ```
617
+
618
+ ### `posthog.surveysQuestionLabels`
619
+
620
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/question_labels/`
621
+ - **What it does**: Return a slim list of question labels for the team's surveys. Used by the frontend to resolve `$survey_response_<question_id>` property keys into human-readable question text without loading the full survey payload.
622
+ - **OpenAPI operationId**: `surveys_question_labels`
623
+ - **Path params**: None
624
+ - **Query params**: None
625
+ - **Response codes**: `200`
626
+ - **Transport options**: None
627
+ - **TypeScript**: [Client interface](../types.ts)
628
+
629
+ **Inputs**
630
+
631
+ - Client input type: `{ [key: string]: unknown }`
632
+ - Client transport options: None
633
+
634
+ **Outputs**
635
+
636
+ - Client return type: `{ labels: ({ question_id: string; question_text: string; question_index: number; survey_id: string; survey_name: string })[] }`
637
+ - OpenAPI response codes: `200`
638
+
639
+ ```ts
640
+ import posthog from "@utdk/posthog";
641
+
642
+ type SurveysQuestionLabelsInput = Parameters<typeof posthog.surveysQuestionLabels> extends [infer T, ...unknown[]] ? T : undefined;
643
+ type SurveysQuestionLabelsOutput = Awaited<ReturnType<typeof posthog.surveysQuestionLabels>>;
644
+
645
+ const result: SurveysQuestionLabelsOutput = await posthog.surveysQuestionLabels();
646
+
647
+ // Result shape (from schema): { labels: ({ question_id: string; question_text: string; question_index: number; survey_id: string; survey_name: string })[] }
648
+ ```
649
+
650
+ ### `posthog.surveysResponsesCountRetrieve`
651
+
652
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/responses_count/`
653
+ - **What it does**: Get response counts for all surveys.
654
+
655
+ Args:
656
+ exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)
657
+ survey_ids: Optional comma-separated list of survey IDs to filter by
658
+
659
+ Returns:
660
+ Dictionary mapping survey IDs to response counts
661
+ - **OpenAPI operationId**: `surveys_responses_count_retrieve`
662
+ - **Path params**: None
663
+ - **Query params**: None
664
+ - **Response codes**: `200`
665
+ - **Transport options**: None
666
+ - **TypeScript**: [Client interface](../types.ts)
667
+
668
+ **Inputs**
669
+
670
+ - Client input type: `{ [key: string]: unknown }`
671
+ - Client transport options: None
672
+
673
+ **Outputs**
674
+
675
+ - Client return type: `unknown`
676
+ - OpenAPI response codes: `200`
677
+
678
+ ```ts
679
+ import posthog from "@utdk/posthog";
680
+
681
+ type SurveysResponsesCountRetrieveInput = Parameters<typeof posthog.surveysResponsesCountRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
682
+ type SurveysResponsesCountRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysResponsesCountRetrieve>>;
683
+
684
+ const result: SurveysResponsesCountRetrieveOutput = await posthog.surveysResponsesCountRetrieve();
685
+
686
+ // Result shape (from schema): unknown
687
+ ```
688
+
689
+ ### `posthog.surveysGlobalStatsRetrieve`
690
+
691
+ - **HTTP**: `GET /api/projects/{project_id}/surveys/stats/`
692
+ - **What it does**: Get aggregated response statistics across all surveys.
693
+
694
+ Args:
695
+ date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)
696
+ date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)
697
+
698
+ Returns:
699
+ Aggregated statistics across all surveys including total counts and rates
700
+ - **OpenAPI operationId**: `surveys_global_stats_retrieve`
701
+ - **Path params**: None
702
+ - **Query params**: `date_from`, `date_to`
703
+ - **Response codes**: `200`
704
+ - **Transport options**: None
705
+ - **TypeScript**: [Client interface](../types.ts)
706
+
707
+ **Inputs**
708
+
709
+ - Client input type: `{ [key: string]: unknown }`
710
+ - Client transport options: None
711
+
712
+ **Outputs**
713
+
714
+ - Client return type: `{ stats: { [key: string]: unknown }; rates: { [key: string]: unknown } }`
715
+ - OpenAPI response codes: `200`
716
+
717
+ ```ts
718
+ import posthog from "@utdk/posthog";
719
+
720
+ type SurveysGlobalStatsRetrieveInput = Parameters<typeof posthog.surveysGlobalStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
721
+ type SurveysGlobalStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.surveysGlobalStatsRetrieve>>;
722
+
723
+ const result: SurveysGlobalStatsRetrieveOutput = await posthog.surveysGlobalStatsRetrieve();
724
+
725
+ // Result shape (from schema): { stats: { [key: string]: unknown }; rates: { [key: string]: unknown } }
726
+ ```
727
+
728
+
729
+ <!-- prompt-hash:
730
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
731
+ -->