@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,44 @@
1
+ # Uploaded Media
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.uploadedMediaCreate`
6
+
7
+ - **HTTP**: `POST /api/projects/{project_id}/uploaded_media/`
8
+ - **What it does**:
9
+ When object storage is available this API allows upload of media which can be used, for example, in text cards on dashboards.
10
+
11
+ Uploaded media must have a content type beginning with 'image/' and be less than 4MB.
12
+
13
+ - **OpenAPI operationId**: `uploaded_media_create`
14
+ - **Path params**: None
15
+ - **Query params**: None
16
+ - **Response codes**: `201`
17
+ - **Transport options**: None
18
+ - **TypeScript**: [Client interface](../types.ts)
19
+
20
+ **Inputs**
21
+
22
+ - Client input type: `{ [key: string]: unknown }`
23
+ - Client transport options: None
24
+
25
+ **Outputs**
26
+
27
+ - Client return type: `{ [key: string]: unknown }`
28
+ - OpenAPI response codes: `201`
29
+
30
+ ```ts
31
+ import posthog from "@utdk/posthog";
32
+
33
+ type UploadedMediaCreateInput = Parameters<typeof posthog.uploadedMediaCreate> extends [infer T, ...unknown[]] ? T : undefined;
34
+ type UploadedMediaCreateOutput = Awaited<ReturnType<typeof posthog.uploadedMediaCreate>>;
35
+
36
+ const result: UploadedMediaCreateOutput = await posthog.uploadedMediaCreate();
37
+
38
+ // Result shape (from schema): { [key: string]: unknown }
39
+ ```
40
+
41
+
42
+ <!-- prompt-hash:
43
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
44
+ -->
@@ -0,0 +1,72 @@
1
+ # User Home Settings
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.userHomeSettingsRetrieve`
6
+
7
+ - **HTTP**: `GET /api/user_home_settings/{uuid}/`
8
+ - **What it does**: Get the authenticated user's pinned sidebar tabs and configured homepage for the current team. Pass `@me` as the UUID.
9
+ - **OpenAPI operationId**: `user_home_settings_retrieve`
10
+ - **Path params**: `uuid`
11
+ - **Query params**: None
12
+ - **Response codes**: `200`
13
+ - **Transport options**: None
14
+ - **TypeScript**: [Client interface](../types.ts)
15
+
16
+ **Inputs**
17
+
18
+ - Client input type: `{ [key: string]: unknown }`
19
+ - Client transport options: None
20
+
21
+ **Outputs**
22
+
23
+ - Client return type: `{ tabs?: ({ id?: string; pathname?: string; search?: string; hash?: string; title?: string; customTitle?: string | null; iconType?: string; sceneId?: string | null; sceneKey?: string | null; sceneParams?: unknown; pinne...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type UserHomeSettingsRetrieveInput = Parameters<typeof posthog.userHomeSettingsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type UserHomeSettingsRetrieveOutput = Awaited<ReturnType<typeof posthog.userHomeSettingsRetrieve>>;
31
+
32
+ const result: UserHomeSettingsRetrieveOutput = await posthog.userHomeSettingsRetrieve();
33
+
34
+ // Result shape (from schema): { tabs?: ({ id?: string; pathname?: string; search?: string; hash?: string; title?: string; customTitle?: string | null; iconType?: string; sceneId?: string | null; sceneKey?: string | null; sceneParams?: unknown; pinne...
35
+ ```
36
+
37
+ ### `posthog.userHomeSettingsPartialUpdate`
38
+
39
+ - **HTTP**: `PATCH /api/user_home_settings/{uuid}/`
40
+ - **What it does**: Update the authenticated user's pinned sidebar tabs and/or homepage for the current team. Pass `@me` as the UUID. Send `tabs` to replace the pinned tab list, `homepage` to set the home destination (any PostHog URL — dashboard, insight, search results, scene). Either field may be omitted to leave it unchanged; sending `homepage: null` or `{}` clears the homepage.
41
+ - **OpenAPI operationId**: `user_home_settings_partial_update`
42
+ - **Path params**: `uuid`
43
+ - **Query params**: None
44
+ - **Response codes**: `200`
45
+ - **Transport options**: None
46
+ - **TypeScript**: [Client interface](../types.ts)
47
+
48
+ **Inputs**
49
+
50
+ - Client input type: `{ [key: string]: unknown }`
51
+ - Client transport options: None
52
+
53
+ **Outputs**
54
+
55
+ - Client return type: `{ tabs?: ({ id?: string; pathname?: string; search?: string; hash?: string; title?: string; customTitle?: string | null; iconType?: string; sceneId?: string | null; sceneKey?: string | null; sceneParams?: unknown; pinne...`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type UserHomeSettingsPartialUpdateInput = Parameters<typeof posthog.userHomeSettingsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type UserHomeSettingsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.userHomeSettingsPartialUpdate>>;
63
+
64
+ const result: UserHomeSettingsPartialUpdateOutput = await posthog.userHomeSettingsPartialUpdate();
65
+
66
+ // Result shape (from schema): { tabs?: ({ id?: string; pathname?: string; search?: string; hash?: string; title?: string; customTitle?: string | null; iconType?: string; sceneId?: string | null; sceneKey?: string | null; sceneParams?: unknown; pinne...
67
+ ```
68
+
69
+
70
+ <!-- prompt-hash:
71
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
72
+ -->