@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,274 @@
1
+ # Actions
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.actionsList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/actions/`
8
+ - **OpenAPI operationId**: `actions_list`
9
+ - **Path params**: None
10
+ - **Query params**: `created_by`, `format`, `limit`, `offset`, `ordering`, `search`, `tags`
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; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type ActionsListInput = Parameters<typeof posthog.actionsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type ActionsListOutput = Awaited<ReturnType<typeof posthog.actionsList>>;
30
+
31
+ const result: ActionsListOutput = await posthog.actionsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({...
34
+ ```
35
+
36
+ ### `posthog.actionsCreate`
37
+
38
+ - **HTTP**: `POST /api/projects/{project_id}/actions/`
39
+ - **OpenAPI operationId**: `actions_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; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type ActionsCreateInput = Parameters<typeof posthog.actionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type ActionsCreateOutput = Awaited<ReturnType<typeof posthog.actionsCreate>>;
61
+
62
+ const result: ActionsCreateOutput = await posthog.actionsCreate();
63
+
64
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...
65
+ ```
66
+
67
+ ### `posthog.actionsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/projects/{project_id}/actions/{id}/`
70
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
71
+ - **OpenAPI operationId**: `actions_destroy`
72
+ - **Path params**: `id`
73
+ - **Query params**: `format`
74
+ - **Response codes**: `405`
75
+ - **Transport options**: None
76
+ - **TypeScript**: [Client interface](../types.ts)
77
+
78
+ **Inputs**
79
+
80
+ - Client input type: `{ [key: string]: unknown }`
81
+ - Client transport options: None
82
+
83
+ **Outputs**
84
+
85
+ - Client return type: `unknown`
86
+ - OpenAPI response codes: `405`
87
+
88
+ ```ts
89
+ import posthog from "@utdk/posthog";
90
+
91
+ type ActionsDestroyInput = Parameters<typeof posthog.actionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
92
+ type ActionsDestroyOutput = Awaited<ReturnType<typeof posthog.actionsDestroy>>;
93
+
94
+ const result: ActionsDestroyOutput = await posthog.actionsDestroy();
95
+
96
+ // Result shape (from schema): unknown
97
+ ```
98
+
99
+ ### `posthog.actionsRetrieve`
100
+
101
+ - **HTTP**: `GET /api/projects/{project_id}/actions/{id}/`
102
+ - **OpenAPI operationId**: `actions_retrieve`
103
+ - **Path params**: `id`
104
+ - **Query params**: `format`
105
+ - **Response codes**: `200`
106
+ - **Transport options**: None
107
+ - **TypeScript**: [Client interface](../types.ts)
108
+
109
+ **Inputs**
110
+
111
+ - Client input type: `{ [key: string]: unknown }`
112
+ - Client transport options: None
113
+
114
+ **Outputs**
115
+
116
+ - Client return type: `{ id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...`
117
+ - OpenAPI response codes: `200`
118
+
119
+ ```ts
120
+ import posthog from "@utdk/posthog";
121
+
122
+ type ActionsRetrieveInput = Parameters<typeof posthog.actionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
123
+ type ActionsRetrieveOutput = Awaited<ReturnType<typeof posthog.actionsRetrieve>>;
124
+
125
+ const result: ActionsRetrieveOutput = await posthog.actionsRetrieve();
126
+
127
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...
128
+ ```
129
+
130
+ ### `posthog.actionsPartialUpdate`
131
+
132
+ - **HTTP**: `PATCH /api/projects/{project_id}/actions/{id}/`
133
+ - **OpenAPI operationId**: `actions_partial_update`
134
+ - **Path params**: `id`
135
+ - **Query params**: `format`
136
+ - **Response codes**: `200`
137
+ - **Transport options**: None
138
+ - **TypeScript**: [Client interface](../types.ts)
139
+
140
+ **Inputs**
141
+
142
+ - Client input type: `{ [key: string]: unknown }`
143
+ - Client transport options: None
144
+
145
+ **Outputs**
146
+
147
+ - Client return type: `{ id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...`
148
+ - OpenAPI response codes: `200`
149
+
150
+ ```ts
151
+ import posthog from "@utdk/posthog";
152
+
153
+ type ActionsPartialUpdateInput = Parameters<typeof posthog.actionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
154
+ type ActionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.actionsPartialUpdate>>;
155
+
156
+ const result: ActionsPartialUpdateOutput = await posthog.actionsPartialUpdate();
157
+
158
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...
159
+ ```
160
+
161
+ ### `posthog.actionsUpdate`
162
+
163
+ - **HTTP**: `PUT /api/projects/{project_id}/actions/{id}/`
164
+ - **OpenAPI operationId**: `actions_update`
165
+ - **Path params**: `id`
166
+ - **Query params**: `format`
167
+ - **Response codes**: `200`
168
+ - **Transport options**: None
169
+ - **TypeScript**: [Client interface](../types.ts)
170
+
171
+ **Inputs**
172
+
173
+ - Client input type: `{ [key: string]: unknown }`
174
+ - Client transport options: None
175
+
176
+ **Outputs**
177
+
178
+ - Client return type: `{ id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...`
179
+ - OpenAPI response codes: `200`
180
+
181
+ ```ts
182
+ import posthog from "@utdk/posthog";
183
+
184
+ type ActionsUpdateInput = Parameters<typeof posthog.actionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
185
+ type ActionsUpdateOutput = Awaited<ReturnType<typeof posthog.actionsUpdate>>;
186
+
187
+ const result: ActionsUpdateOutput = await posthog.actionsUpdate();
188
+
189
+ // Result shape (from schema): { id: number; name?: string | null; description?: string; tags?: (unknown)[]; post_to_slack?: boolean; slack_message_format?: string; steps?: ({ event?: string | null; properties?: unknown[] | null; selector?: string | ...
190
+ ```
191
+
192
+ ### `posthog.actionsReferencesList`
193
+
194
+ - **HTTP**: `GET /api/projects/{project_id}/actions/{id}/references/`
195
+ - **OpenAPI operationId**: `actions_references_list`
196
+ - **Path params**: `id`
197
+ - **Query params**: `format`
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: `({ type: string; id: string; name: string; url: string; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...`
210
+ - OpenAPI response codes: `200`
211
+
212
+ ```ts
213
+ import posthog from "@utdk/posthog";
214
+
215
+ type ActionsReferencesListInput = Parameters<typeof posthog.actionsReferencesList> extends [infer T, ...unknown[]] ? T : undefined;
216
+ type ActionsReferencesListOutput = Awaited<ReturnType<typeof posthog.actionsReferencesList>>;
217
+
218
+ const result: ActionsReferencesListOutput = await posthog.actionsReferencesList();
219
+
220
+ // Result shape (from schema): ({ type: string; id: string; name: string; url: string; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...
221
+ ```
222
+
223
+ ### `posthog.actionsBulkUpdateTagsCreate`
224
+
225
+ - **HTTP**: `POST /api/projects/{project_id}/actions/bulk_update_tags/`
226
+ - **What it does**: Bulk update tags on multiple objects.
227
+
228
+ PAT access: this action has no ``required_scopes=`` on the decorator —
229
+ inheriting viewsets must add ``"bulk_update_tags"`` to their
230
+ ``scope_object_write_actions`` list to accept personal API keys.
231
+ Without that opt-in, ``APIScopePermission`` rejects PAT requests with
232
+ "This action does not support personal API key access". Done per-viewset
233
+ so granting ``<scope>:write`` for one resource doesn't leak access to
234
+ sibling resources that share this mixin.
235
+
236
+ Accepts:
237
+ - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}
238
+
239
+ Actions:
240
+ - "add": Add tags to existing tags on each object
241
+ - "remove": Remove specific tags from each object
242
+ - "set": Replace all tags on each object with the provided list
243
+ - **OpenAPI operationId**: `actions_bulk_update_tags_create`
244
+ - **Path params**: None
245
+ - **Query params**: `format`
246
+ - **Response codes**: `200`
247
+ - **Transport options**: None
248
+ - **TypeScript**: [Client interface](../types.ts)
249
+
250
+ **Inputs**
251
+
252
+ - Client input type: `{ [key: string]: unknown }`
253
+ - Client transport options: None
254
+
255
+ **Outputs**
256
+
257
+ - Client return type: `{ updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }`
258
+ - OpenAPI response codes: `200`
259
+
260
+ ```ts
261
+ import posthog from "@utdk/posthog";
262
+
263
+ type ActionsBulkUpdateTagsCreateInput = Parameters<typeof posthog.actionsBulkUpdateTagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
264
+ type ActionsBulkUpdateTagsCreateOutput = Awaited<ReturnType<typeof posthog.actionsBulkUpdateTagsCreate>>;
265
+
266
+ const result: ActionsBulkUpdateTagsCreateOutput = await posthog.actionsBulkUpdateTagsCreate();
267
+
268
+ // Result shape (from schema): { updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }
269
+ ```
270
+
271
+
272
+ <!-- prompt-hash:
273
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
274
+ -->
@@ -0,0 +1,144 @@
1
+ # Activity Logs
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.orgOrganizationsAdvancedActivityLogsList`
6
+
7
+ - **HTTP**: `GET /api/organizations/{organization_id}/advanced_activity_logs/`
8
+ - **What it does**: Organization-wide view of activity logs across every project in the organization.
9
+
10
+ Mounted at /api/organizations/<organization_id>/advanced_activity_logs/.
11
+ Restricted to organization admins and owners.
12
+ - **OpenAPI operationId**: `org_organizations_advanced_activity_logs_list`
13
+ - **Path params**: None
14
+ - **Query params**: `activities`, `clients`, `detail_filters`, `end_date`, `hogql_filter`, `ip_addresses`, `is_system`, `item_ids`, `page`, `page_size`, `scopes`, `search_text`, `start_date`, `team_ids`, `users`, `was_impersonated`
15
+ - **Response codes**: `200`
16
+ - **Transport options**: None
17
+ - **TypeScript**: [Client interface](../types.ts)
18
+
19
+ **Inputs**
20
+
21
+ - Client input type: `{ [key: string]: unknown }`
22
+ - Client transport options: None
23
+
24
+ **Outputs**
25
+
26
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...`
27
+ - OpenAPI response codes: `200`
28
+
29
+ ```ts
30
+ import posthog from "@utdk/posthog";
31
+
32
+ type OrgOrganizationsAdvancedActivityLogsListInput = Parameters<typeof posthog.orgOrganizationsAdvancedActivityLogsList> extends [infer T, ...unknown[]] ? T : undefined;
33
+ type OrgOrganizationsAdvancedActivityLogsListOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsAdvancedActivityLogsList>>;
34
+
35
+ const result: OrgOrganizationsAdvancedActivityLogsListOutput = await posthog.orgOrganizationsAdvancedActivityLogsList();
36
+
37
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...
38
+ ```
39
+
40
+ ### `posthog.orgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieve`
41
+
42
+ - **HTTP**: `GET /api/organizations/{organization_id}/advanced_activity_logs/available_filters/`
43
+ - **What it does**: Organization-wide view of activity logs across every project in the organization.
44
+
45
+ Mounted at /api/organizations/<organization_id>/advanced_activity_logs/.
46
+ Restricted to organization admins and owners.
47
+ - **OpenAPI operationId**: `org_organizations_advanced_activity_logs_available_filters_retrieve`
48
+ - **Path params**: None
49
+ - **Query params**: None
50
+ - **Response codes**: `200`
51
+ - **Transport options**: None
52
+ - **TypeScript**: [Client interface](../types.ts)
53
+
54
+ **Inputs**
55
+
56
+ - Client input type: `{ [key: string]: unknown }`
57
+ - Client transport options: None
58
+
59
+ **Outputs**
60
+
61
+ - Client return type: `{ static_filters: { users: ({ [key: string]: unknown })[]; scopes: ({ [key: string]: unknown })[]; activities: ({ [key: string]: unknown })[]; clients: ({ [key: string]: unknown })[] }; detail_fields: { [key: string]: u...`
62
+ - OpenAPI response codes: `200`
63
+
64
+ ```ts
65
+ import posthog from "@utdk/posthog";
66
+
67
+ type OrgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieveInput = Parameters<typeof posthog.orgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
68
+ type OrgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieveOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieve>>;
69
+
70
+ const result: OrgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieveOutput = await posthog.orgOrganizationsAdvancedActivityLogsAvailableFiltersRetrieve();
71
+
72
+ // Result shape (from schema): { static_filters: { users: ({ [key: string]: unknown })[]; scopes: ({ [key: string]: unknown })[]; activities: ({ [key: string]: unknown })[]; clients: ({ [key: string]: unknown })[] }; detail_fields: { [key: string]: u...
73
+ ```
74
+
75
+ ### `posthog.orgOrganizationsAdvancedActivityLogsExportCreate`
76
+
77
+ - **HTTP**: `POST /api/organizations/{organization_id}/advanced_activity_logs/export/`
78
+ - **What it does**: Organization-wide view of activity logs across every project in the organization.
79
+
80
+ Mounted at /api/organizations/<organization_id>/advanced_activity_logs/.
81
+ Restricted to organization admins and owners.
82
+ - **OpenAPI operationId**: `org_organizations_advanced_activity_logs_export_create`
83
+ - **Path params**: None
84
+ - **Query params**: None
85
+ - **Response codes**: `200`
86
+ - **Transport options**: None
87
+ - **TypeScript**: [Client interface](../types.ts)
88
+
89
+ **Inputs**
90
+
91
+ - Client input type: `{ [key: string]: unknown }`
92
+ - Client transport options: None
93
+
94
+ **Outputs**
95
+
96
+ - Client return type: `{ id: string; 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: string]: unknown } | null...`
97
+ - OpenAPI response codes: `200`
98
+
99
+ ```ts
100
+ import posthog from "@utdk/posthog";
101
+
102
+ type OrgOrganizationsAdvancedActivityLogsExportCreateInput = Parameters<typeof posthog.orgOrganizationsAdvancedActivityLogsExportCreate> extends [infer T, ...unknown[]] ? T : undefined;
103
+ type OrgOrganizationsAdvancedActivityLogsExportCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsAdvancedActivityLogsExportCreate>>;
104
+
105
+ const result: OrgOrganizationsAdvancedActivityLogsExportCreateOutput = await posthog.orgOrganizationsAdvancedActivityLogsExportCreate();
106
+
107
+ // Result shape (from schema): { id: string; 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: string]: unknown } | null...
108
+ ```
109
+
110
+ ### `posthog.activityLogList`
111
+
112
+ - **HTTP**: `GET /api/projects/{project_id}/activity_log/`
113
+ - **OpenAPI operationId**: `activity_log_list`
114
+ - **Path params**: None
115
+ - **Query params**: `item_id`, `page`, `page_size`, `scope`, `scopes`, `user`
116
+ - **Response codes**: `200`
117
+ - **Transport options**: None
118
+ - **TypeScript**: [Client interface](../types.ts)
119
+
120
+ **Inputs**
121
+
122
+ - Client input type: `{ [key: string]: unknown }`
123
+ - Client transport options: None
124
+
125
+ **Outputs**
126
+
127
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...`
128
+ - OpenAPI response codes: `200`
129
+
130
+ ```ts
131
+ import posthog from "@utdk/posthog";
132
+
133
+ type ActivityLogListInput = Parameters<typeof posthog.activityLogList> extends [infer T, ...unknown[]] ? T : undefined;
134
+ type ActivityLogListOutput = Awaited<ReturnType<typeof posthog.activityLogList>>;
135
+
136
+ const result: ActivityLogListOutput = await posthog.activityLogList();
137
+
138
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...
139
+ ```
140
+
141
+
142
+ <!-- prompt-hash:
143
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
144
+ -->
@@ -0,0 +1,101 @@
1
+ # Advanced Activity Logs
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.advancedActivityLogsList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/advanced_activity_logs/`
8
+ - **OpenAPI operationId**: `advanced_activity_logs_list`
9
+ - **Path params**: None
10
+ - **Query params**: `activities`, `clients`, `detail_filters`, `end_date`, `hogql_filter`, `ip_addresses`, `is_system`, `item_ids`, `page`, `page_size`, `scopes`, `search_text`, `start_date`, `team_ids`, `users`, `was_impersonated`
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; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type AdvancedActivityLogsListInput = Parameters<typeof posthog.advancedActivityLogsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type AdvancedActivityLogsListOutput = Awaited<ReturnType<typeof posthog.advancedActivityLogsList>>;
30
+
31
+ const result: AdvancedActivityLogsListOutput = await posthog.advancedActivityLogsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...
34
+ ```
35
+
36
+ ### `posthog.advancedActivityLogsAvailableFiltersRetrieve`
37
+
38
+ - **HTTP**: `GET /api/projects/{project_id}/advanced_activity_logs/available_filters/`
39
+ - **OpenAPI operationId**: `advanced_activity_logs_available_filters_retrieve`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `200`
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: `{ static_filters: { users: ({ [key: string]: unknown })[]; scopes: ({ [key: string]: unknown })[]; activities: ({ [key: string]: unknown })[]; clients: ({ [key: string]: unknown })[] }; detail_fields: { [key: string]: u...`
54
+ - OpenAPI response codes: `200`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type AdvancedActivityLogsAvailableFiltersRetrieveInput = Parameters<typeof posthog.advancedActivityLogsAvailableFiltersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type AdvancedActivityLogsAvailableFiltersRetrieveOutput = Awaited<ReturnType<typeof posthog.advancedActivityLogsAvailableFiltersRetrieve>>;
61
+
62
+ const result: AdvancedActivityLogsAvailableFiltersRetrieveOutput = await posthog.advancedActivityLogsAvailableFiltersRetrieve();
63
+
64
+ // Result shape (from schema): { static_filters: { users: ({ [key: string]: unknown })[]; scopes: ({ [key: string]: unknown })[]; activities: ({ [key: string]: unknown })[]; clients: ({ [key: string]: unknown })[] }; detail_fields: { [key: string]: u...
65
+ ```
66
+
67
+ ### `posthog.advancedActivityLogsExportCreate`
68
+
69
+ - **HTTP**: `POST /api/projects/{project_id}/advanced_activity_logs/export/`
70
+ - **OpenAPI operationId**: `advanced_activity_logs_export_create`
71
+ - **Path params**: None
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; 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: string]: unknown } | null...`
85
+ - OpenAPI response codes: `200`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type AdvancedActivityLogsExportCreateInput = Parameters<typeof posthog.advancedActivityLogsExportCreate> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type AdvancedActivityLogsExportCreateOutput = Awaited<ReturnType<typeof posthog.advancedActivityLogsExportCreate>>;
92
+
93
+ const result: AdvancedActivityLogsExportCreateOutput = await posthog.advancedActivityLogsExportCreate();
94
+
95
+ // Result shape (from schema): { id: string; 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: string]: unknown } | null...
96
+ ```
97
+
98
+
99
+ <!-- prompt-hash:
100
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
101
+ -->