@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.
- package/LICENSE +373 -0
- package/README.md +172 -0
- package/docs/account_relationship_definitions.md +194 -0
- package/docs/accounts.md +380 -0
- package/docs/actions.md +274 -0
- package/docs/activity_logs.md +144 -0
- package/docs/advanced_activity_logs.md +101 -0
- package/docs/agent_platform.md +2525 -0
- package/docs/ai-observability.md +514 -0
- package/docs/alerts.md +444 -0
- package/docs/annotations.md +200 -0
- package/docs/batch_exports.md +2118 -0
- package/docs/business_knowledge.md +468 -0
- package/docs/code-invites.md +72 -0
- package/docs/cohorts.md +412 -0
- package/docs/comments.md +321 -0
- package/docs/conversations.md +695 -0
- package/docs/custom_property_definitions.md +442 -0
- package/docs/custom_property_sources.md +194 -0
- package/docs/customer_analytics.md +442 -0
- package/docs/customer_journeys.md +380 -0
- package/docs/customer_profile_configs.md +380 -0
- package/docs/dashboard_templates.md +258 -0
- package/docs/dashboards.md +1896 -0
- package/docs/data_color_themes.md +380 -0
- package/docs/data_modeling_jobs.md +264 -0
- package/docs/data_warehouse.md +928 -0
- package/docs/dataset_items.md +382 -0
- package/docs/datasets.md +382 -0
- package/docs/desktop_file_system.md +753 -0
- package/docs/desktop_file_system_shortcut.md +244 -0
- package/docs/docs.md +72 -0
- package/docs/early_access_feature.md +194 -0
- package/docs/elements.md +510 -0
- package/docs/endpoints.md +1030 -0
- package/docs/engineering_analytics.md +712 -0
- package/docs/environments.md +881 -0
- package/docs/error_tracking.md +5108 -0
- package/docs/evaluation_runs.md +78 -0
- package/docs/evaluations.md +446 -0
- package/docs/event_definitions.md +425 -0
- package/docs/event_filter.md +280 -0
- package/docs/event_schemas.md +163 -0
- package/docs/events.md +208 -0
- package/docs/experiment_holdouts.md +194 -0
- package/docs/experiment_saved_metrics.md +194 -0
- package/docs/experiments.md +1088 -0
- package/docs/exports.md +256 -0
- package/docs/external_data_schemas.md +752 -0
- package/docs/external_data_sources.md +2296 -0
- package/docs/feature_flags.md +808 -0
- package/docs/field_notes.md +206 -0
- package/docs/file_system.md +880 -0
- package/docs/file_system_shortcut.md +444 -0
- package/docs/flag_value.md +46 -0
- package/docs/groups.md +514 -0
- package/docs/groups_types.md +349 -0
- package/docs/health_issues.md +386 -0
- package/docs/heatmap_screenshots.md +72 -0
- package/docs/heatmaps.md +136 -0
- package/docs/hog_flows.md +1576 -0
- package/docs/hog_function_templates.md +101 -0
- package/docs/hog_functions.md +974 -0
- package/docs/ingestion_warnings_v2.md +40 -0
- package/docs/insight_variables.md +380 -0
- package/docs/insights.md +1722 -0
- package/docs/integrations.md +1954 -0
- package/docs/js-snippet.md +104 -0
- package/docs/live_debugger_breakpoints.md +264 -0
- package/docs/llm_analytics.md +3373 -0
- package/docs/llm_prompts.md +442 -0
- package/docs/llm_skills.md +952 -0
- package/docs/logs.md +2446 -0
- package/docs/managed_viewsets.md +140 -0
- package/docs/marketing_analytics.md +518 -0
- package/docs/max.md +772 -0
- package/docs/max_tools.md +70 -0
- package/docs/mcp_analytics.md +712 -0
- package/docs/mcp_server_installations.md +970 -0
- package/docs/mcp_servers.md +78 -0
- package/docs/mcp_tools.md +82 -0
- package/docs/messaging_templates.md +444 -0
- package/docs/metrics.md +462 -0
- package/docs/notebooks.md +838 -0
- package/docs/object_media_previews.md +228 -0
- package/docs/organizations.md +2958 -0
- package/docs/persons.md +1514 -0
- package/docs/platform_features.md +700 -0
- package/docs/plugin_configs.md +70 -0
- package/docs/product_enablement.md +39 -0
- package/docs/product_tours.md +357 -0
- package/docs/project_secret_api_keys.md +444 -0
- package/docs/property_access_controls.md +200 -0
- package/docs/property_definitions.md +244 -0
- package/docs/query.md +560 -0
- package/docs/quota_limits.md +40 -0
- package/docs/reminders.md +194 -0
- package/docs/replay.md +1020 -0
- package/docs/reverse_proxy.md +200 -0
- package/docs/sandbox-custom-images.md +209 -0
- package/docs/sandbox-environments.md +168 -0
- package/docs/saved.md +392 -0
- package/docs/saved_query_column_annotations.md +224 -0
- package/docs/scheduled_changes.md +200 -0
- package/docs/schema_property_groups.md +194 -0
- package/docs/sdk_health.md +40 -0
- package/docs/session_group_summaries.md +200 -0
- package/docs/session_recordings.md +260 -0
- package/docs/session_summaries.md +200 -0
- package/docs/sessions.md +132 -0
- package/docs/signals.md +1428 -0
- package/docs/single_session_summaries.md +72 -0
- package/docs/streamlit_apps.md +456 -0
- package/docs/subscriptions.md +634 -0
- package/docs/surveys.md +731 -0
- package/docs/taggers.md +446 -0
- package/docs/task-automations.md +200 -0
- package/docs/task-runs.md +654 -0
- package/docs/task_channels.md +136 -0
- package/docs/task_mentions.md +40 -0
- package/docs/tasks.md +776 -0
- package/docs/tracing.md +1186 -0
- package/docs/uploaded_media.md +44 -0
- package/docs/user_home_settings.md +72 -0
- package/docs/user_interview_topics.md +1288 -0
- package/docs/user_interviews.md +444 -0
- package/docs/users.md +1267 -0
- package/docs/vision.md +2022 -0
- package/docs/visual_review.md +816 -0
- package/docs/warehouse_column_annotations.md +224 -0
- package/docs/warehouse_column_statistics.md +80 -0
- package/docs/warehouse_dag.md +40 -0
- package/docs/warehouse_model_paths.md +70 -0
- package/docs/warehouse_saved_queries.md +1056 -0
- package/docs/warehouse_saved_query_folders.md +318 -0
- package/docs/warehouse_tables.md +584 -0
- package/docs/warehouse_view_link.md +456 -0
- package/docs/warehouse_view_links.md +456 -0
- package/docs/web_analytics.md +136 -0
- package/docs/web_analytics_achievements.md +200 -0
- package/docs/web_experiments.md +194 -0
- package/docs/web_vitals.md +74 -0
- package/docs/wizard.md +170 -0
- package/index.ts +22 -0
- package/metadata.ts +41419 -0
- package/openapi.json +297382 -0
- package/overlay.yaml +23 -0
- package/package.json +34 -0
- package/provenance.json +24 -0
- package/research.json +80 -0
- package/types/index.ts +17547 -0
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# Web Analytics Achievements
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.webAnalyticsAchievementsAcknowledgeCelebration`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `POST /api/projects/{project_id}/web_analytics_achievements/acknowledge_celebration/`
|
|
8
|
+
- **What it does**: Acknowledge an achievement celebration
|
|
9
|
+
- **OpenAPI operationId**: `web_analytics_achievements_acknowledge_celebration`
|
|
10
|
+
- **Path params**: None
|
|
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: `{ acknowledged: boolean }`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type WebAnalyticsAchievementsAcknowledgeCelebrationInput = Parameters<typeof posthog.webAnalyticsAchievementsAcknowledgeCelebration> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type WebAnalyticsAchievementsAcknowledgeCelebrationOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsAcknowledgeCelebration>>;
|
|
31
|
+
|
|
32
|
+
const result: WebAnalyticsAchievementsAcknowledgeCelebrationOutput = await posthog.webAnalyticsAchievementsAcknowledgeCelebration();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { acknowledged: boolean }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.webAnalyticsAchievementsOverview`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `GET /api/projects/{project_id}/web_analytics_achievements/overview/`
|
|
40
|
+
- **What it does**: Get Web analytics achievements overview
|
|
41
|
+
- **OpenAPI operationId**: `web_analytics_achievements_overview`
|
|
42
|
+
- **Path params**: None
|
|
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: `{ definitions: ({ key: string; display_name: string; description: string; scope: "user" | "team"; is_experiment_track: boolean; stages: ({ stage: number; name: string; threshold: number })[] })[]; user_progress: ({ trac...`
|
|
56
|
+
- OpenAPI response codes: `200`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type WebAnalyticsAchievementsOverviewInput = Parameters<typeof posthog.webAnalyticsAchievementsOverview> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type WebAnalyticsAchievementsOverviewOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsOverview>>;
|
|
63
|
+
|
|
64
|
+
const result: WebAnalyticsAchievementsOverviewOutput = await posthog.webAnalyticsAchievementsOverview();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { definitions: ({ key: string; display_name: string; description: string; scope: "user" | "team"; is_experiment_track: boolean; stages: ({ stage: number; name: string; threshold: number })[] })[]; user_progress: ({ trac...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.webAnalyticsAchievementsPreferences`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `GET /api/projects/{project_id}/web_analytics_achievements/preferences/`
|
|
72
|
+
- **What it does**: Get Web analytics achievements preferences
|
|
73
|
+
- **OpenAPI operationId**: `web_analytics_achievements_preferences`
|
|
74
|
+
- **Path params**: None
|
|
75
|
+
- **Query params**: None
|
|
76
|
+
- **Response codes**: `200`
|
|
77
|
+
- **Transport options**: None
|
|
78
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
79
|
+
|
|
80
|
+
**Inputs**
|
|
81
|
+
|
|
82
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
83
|
+
- Client transport options: None
|
|
84
|
+
|
|
85
|
+
**Outputs**
|
|
86
|
+
|
|
87
|
+
- Client return type: `{ achievements_opt_out: boolean }`
|
|
88
|
+
- OpenAPI response codes: `200`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type WebAnalyticsAchievementsPreferencesInput = Parameters<typeof posthog.webAnalyticsAchievementsPreferences> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type WebAnalyticsAchievementsPreferencesOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsPreferences>>;
|
|
95
|
+
|
|
96
|
+
const result: WebAnalyticsAchievementsPreferencesOutput = await posthog.webAnalyticsAchievementsPreferences();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): { achievements_opt_out: boolean }
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.webAnalyticsAchievementsUpdatePreferences`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `POST /api/projects/{project_id}/web_analytics_achievements/preferences/`
|
|
104
|
+
- **What it does**: Update Web analytics achievements preferences
|
|
105
|
+
- **OpenAPI operationId**: `web_analytics_achievements_update_preferences`
|
|
106
|
+
- **Path params**: None
|
|
107
|
+
- **Query params**: None
|
|
108
|
+
- **Response codes**: `200`
|
|
109
|
+
- **Transport options**: None
|
|
110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
111
|
+
|
|
112
|
+
**Inputs**
|
|
113
|
+
|
|
114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
115
|
+
- Client transport options: None
|
|
116
|
+
|
|
117
|
+
**Outputs**
|
|
118
|
+
|
|
119
|
+
- Client return type: `{ achievements_opt_out: boolean }`
|
|
120
|
+
- OpenAPI response codes: `200`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type WebAnalyticsAchievementsUpdatePreferencesInput = Parameters<typeof posthog.webAnalyticsAchievementsUpdatePreferences> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type WebAnalyticsAchievementsUpdatePreferencesOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsUpdatePreferences>>;
|
|
127
|
+
|
|
128
|
+
const result: WebAnalyticsAchievementsUpdatePreferencesOutput = await posthog.webAnalyticsAchievementsUpdatePreferences();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { achievements_opt_out: boolean }
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.webAnalyticsAchievementsRecordInteraction`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `POST /api/projects/{project_id}/web_analytics_achievements/record_interaction/`
|
|
136
|
+
- **What it does**: Record a Web analytics interaction
|
|
137
|
+
- **OpenAPI operationId**: `web_analytics_achievements_record_interaction`
|
|
138
|
+
- **Path params**: None
|
|
139
|
+
- **Query params**: None
|
|
140
|
+
- **Response codes**: `200`
|
|
141
|
+
- **Transport options**: None
|
|
142
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
143
|
+
|
|
144
|
+
**Inputs**
|
|
145
|
+
|
|
146
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
147
|
+
- Client transport options: None
|
|
148
|
+
|
|
149
|
+
**Outputs**
|
|
150
|
+
|
|
151
|
+
- Client return type: `{ recorded: boolean }`
|
|
152
|
+
- OpenAPI response codes: `200`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type WebAnalyticsAchievementsRecordInteractionInput = Parameters<typeof posthog.webAnalyticsAchievementsRecordInteraction> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type WebAnalyticsAchievementsRecordInteractionOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsRecordInteraction>>;
|
|
159
|
+
|
|
160
|
+
const result: WebAnalyticsAchievementsRecordInteractionOutput = await posthog.webAnalyticsAchievementsRecordInteraction();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { recorded: boolean }
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.webAnalyticsAchievementsRecordVisit`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `POST /api/projects/{project_id}/web_analytics_achievements/record_visit/`
|
|
168
|
+
- **What it does**: Record a Web analytics visit
|
|
169
|
+
- **OpenAPI operationId**: `web_analytics_achievements_record_visit`
|
|
170
|
+
- **Path params**: None
|
|
171
|
+
- **Query params**: None
|
|
172
|
+
- **Response codes**: `200`
|
|
173
|
+
- **Transport options**: None
|
|
174
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
175
|
+
|
|
176
|
+
**Inputs**
|
|
177
|
+
|
|
178
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
179
|
+
- Client transport options: None
|
|
180
|
+
|
|
181
|
+
**Outputs**
|
|
182
|
+
|
|
183
|
+
- Client return type: `{ recorded: boolean }`
|
|
184
|
+
- OpenAPI response codes: `200`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type WebAnalyticsAchievementsRecordVisitInput = Parameters<typeof posthog.webAnalyticsAchievementsRecordVisit> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type WebAnalyticsAchievementsRecordVisitOutput = Awaited<ReturnType<typeof posthog.webAnalyticsAchievementsRecordVisit>>;
|
|
191
|
+
|
|
192
|
+
const result: WebAnalyticsAchievementsRecordVisitOutput = await posthog.webAnalyticsAchievementsRecordVisit();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { recorded: boolean }
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<!-- prompt-hash:
|
|
199
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
200
|
+
-->
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# Web Experiments
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.webExperimentsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/web_experiments/`
|
|
8
|
+
- **OpenAPI operationId**: `web_experiments_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `limit`, `offset`
|
|
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; created_at?: string; feature_flag_key: string; variants: unknown })[] }`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type WebExperimentsListInput = Parameters<typeof posthog.webExperimentsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type WebExperimentsListOutput = Awaited<ReturnType<typeof posthog.webExperimentsList>>;
|
|
30
|
+
|
|
31
|
+
const result: WebExperimentsListOutput = await posthog.webExperimentsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown })[] }
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.webExperimentsCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/projects/{project_id}/web_experiments/`
|
|
39
|
+
- **OpenAPI operationId**: `web_experiments_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: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type WebExperimentsCreateInput = Parameters<typeof posthog.webExperimentsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type WebExperimentsCreateOutput = Awaited<ReturnType<typeof posthog.webExperimentsCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: WebExperimentsCreateOutput = await posthog.webExperimentsCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.webExperimentsDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/web_experiments/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `web_experiments_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 WebExperimentsDestroyInput = Parameters<typeof posthog.webExperimentsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type WebExperimentsDestroyOutput = Awaited<ReturnType<typeof posthog.webExperimentsDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: WebExperimentsDestroyOutput = await posthog.webExperimentsDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.webExperimentsRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/projects/{project_id}/web_experiments/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `web_experiments_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: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type WebExperimentsRetrieveInput = Parameters<typeof posthog.webExperimentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type WebExperimentsRetrieveOutput = Awaited<ReturnType<typeof posthog.webExperimentsRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: WebExperimentsRetrieveOutput = await posthog.webExperimentsRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.webExperimentsPartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/web_experiments/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `web_experiments_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: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type WebExperimentsPartialUpdateInput = Parameters<typeof posthog.webExperimentsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type WebExperimentsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.webExperimentsPartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: WebExperimentsPartialUpdateOutput = await posthog.webExperimentsPartialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.webExperimentsUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/projects/{project_id}/web_experiments/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `web_experiments_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: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type WebExperimentsUpdateInput = Parameters<typeof posthog.webExperimentsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type WebExperimentsUpdateOutput = Awaited<ReturnType<typeof posthog.webExperimentsUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: WebExperimentsUpdateOutput = await posthog.webExperimentsUpdate();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: number; name: string; created_at?: string; feature_flag_key: string; variants: unknown }
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<!-- prompt-hash:
|
|
193
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
194
|
+
-->
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Web Vitals
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsWebVitalsRetrieve`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/web_vitals/`
|
|
8
|
+
- **What it does**: Get web vitals for a specific pathname.
|
|
9
|
+
Toolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators).
|
|
10
|
+
- **OpenAPI operationId**: `environments_web_vitals_retrieve`
|
|
11
|
+
- **Path params**: None
|
|
12
|
+
- **Query params**: `pathname`
|
|
13
|
+
- **Response codes**: `200`
|
|
14
|
+
- **Transport options**: None
|
|
15
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
16
|
+
|
|
17
|
+
**Inputs**
|
|
18
|
+
|
|
19
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
20
|
+
- Client transport options: None
|
|
21
|
+
|
|
22
|
+
**Outputs**
|
|
23
|
+
|
|
24
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
25
|
+
- OpenAPI response codes: `200`
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import posthog from "@utdk/posthog";
|
|
29
|
+
|
|
30
|
+
type EnvironmentsWebVitalsRetrieveInput = Parameters<typeof posthog.environmentsWebVitalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
31
|
+
type EnvironmentsWebVitalsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsWebVitalsRetrieve>>;
|
|
32
|
+
|
|
33
|
+
const result: EnvironmentsWebVitalsRetrieveOutput = await posthog.environmentsWebVitalsRetrieve();
|
|
34
|
+
|
|
35
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### `posthog.webVitalsRetrieve`
|
|
39
|
+
|
|
40
|
+
- **HTTP**: `GET /api/projects/{project_id}/web_vitals/`
|
|
41
|
+
- **What it does**: Get web vitals for a specific pathname.
|
|
42
|
+
Toolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators).
|
|
43
|
+
- **OpenAPI operationId**: `web_vitals_retrieve`
|
|
44
|
+
- **Path params**: None
|
|
45
|
+
- **Query params**: `pathname`
|
|
46
|
+
- **Response codes**: `200`
|
|
47
|
+
- **Transport options**: None
|
|
48
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
49
|
+
|
|
50
|
+
**Inputs**
|
|
51
|
+
|
|
52
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
53
|
+
- Client transport options: None
|
|
54
|
+
|
|
55
|
+
**Outputs**
|
|
56
|
+
|
|
57
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
58
|
+
- OpenAPI response codes: `200`
|
|
59
|
+
|
|
60
|
+
```ts
|
|
61
|
+
import posthog from "@utdk/posthog";
|
|
62
|
+
|
|
63
|
+
type WebVitalsRetrieveInput = Parameters<typeof posthog.webVitalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
64
|
+
type WebVitalsRetrieveOutput = Awaited<ReturnType<typeof posthog.webVitalsRetrieve>>;
|
|
65
|
+
|
|
66
|
+
const result: WebVitalsRetrieveOutput = await posthog.webVitalsRetrieve();
|
|
67
|
+
|
|
68
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<!-- prompt-hash:
|
|
73
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
74
|
+
-->
|
package/docs/wizard.md
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Wizard
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.wizardSessionsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/wizard/sessions/`
|
|
8
|
+
- **What it does**: List wizard sessions for the project, ordered by started_at desc. This should only be called by the PostHog Wizard. Optional filters: ?workflow_id=<id> and ?skill_id=<id>.
|
|
9
|
+
- **OpenAPI operationId**: `wizard_sessions_list`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `limit`, `offset`, `skill_id`, `workflow_id`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | ...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type WizardSessionsListInput = Parameters<typeof posthog.wizardSessionsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type WizardSessionsListOutput = Awaited<ReturnType<typeof posthog.wizardSessionsList>>;
|
|
31
|
+
|
|
32
|
+
const result: WizardSessionsListOutput = await posthog.wizardSessionsList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | ...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.wizardSessionsCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/wizard/sessions/`
|
|
40
|
+
- **What it does**: Upsert a wizard session. The `session_id` key is the idempotency anchor — reposting the same `session_id` replaces the existing row. Returns 201 on create, 200 on update.
|
|
41
|
+
- **OpenAPI operationId**: `wizard_sessions_create`
|
|
42
|
+
- **Path params**: None
|
|
43
|
+
- **Query params**: None
|
|
44
|
+
- **Response codes**: `200`, `201`
|
|
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: `{ session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...`
|
|
56
|
+
- OpenAPI response codes: `200`, `201`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type WizardSessionsCreateInput = Parameters<typeof posthog.wizardSessionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type WizardSessionsCreateOutput = Awaited<ReturnType<typeof posthog.wizardSessionsCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: WizardSessionsCreateOutput = await posthog.wizardSessionsCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.wizardSessionsRetrieve`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `GET /api/projects/{project_id}/wizard/sessions/{session_id}/`
|
|
72
|
+
- **What it does**: Retrieve a single wizard session by its session_id.
|
|
73
|
+
- **OpenAPI operationId**: `wizard_sessions_retrieve`
|
|
74
|
+
- **Path params**: `session_id`
|
|
75
|
+
- **Query params**: None
|
|
76
|
+
- **Response codes**: `200`, `404`
|
|
77
|
+
- **Transport options**: None
|
|
78
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
79
|
+
|
|
80
|
+
**Inputs**
|
|
81
|
+
|
|
82
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
83
|
+
- Client transport options: None
|
|
84
|
+
|
|
85
|
+
**Outputs**
|
|
86
|
+
|
|
87
|
+
- Client return type: `{ session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...`
|
|
88
|
+
- OpenAPI response codes: `200`, `404`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type WizardSessionsRetrieveInput = Parameters<typeof posthog.wizardSessionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type WizardSessionsRetrieveOutput = Awaited<ReturnType<typeof posthog.wizardSessionsRetrieve>>;
|
|
95
|
+
|
|
96
|
+
const result: WizardSessionsRetrieveOutput = await posthog.wizardSessionsRetrieve();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): { session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.wizardSessionsLatestRetrieve`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `GET /api/projects/{project_id}/wizard/sessions/latest/`
|
|
104
|
+
- **What it does**: Return the single most-recent wizard session for a workflow (and optional skill), or 204 if none exists. Unlike `list`, this is a point lookup the app shell uses to decide whether to open the live SSE stream — it never returns a collection, and 'no run' is a 204 rather than a 404 so clients don't conflate it with a missing endpoint.
|
|
105
|
+
- **OpenAPI operationId**: `wizard_sessions_latest_retrieve`
|
|
106
|
+
- **Path params**: None
|
|
107
|
+
- **Query params**: `skill_id`, `workflow_id`
|
|
108
|
+
- **Response codes**: `200`, `204`
|
|
109
|
+
- **Transport options**: None
|
|
110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
111
|
+
|
|
112
|
+
**Inputs**
|
|
113
|
+
|
|
114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
115
|
+
- Client transport options: None
|
|
116
|
+
|
|
117
|
+
**Outputs**
|
|
118
|
+
|
|
119
|
+
- Client return type: `{ session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...`
|
|
120
|
+
- OpenAPI response codes: `200`, `204`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type WizardSessionsLatestRetrieveInput = Parameters<typeof posthog.wizardSessionsLatestRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type WizardSessionsLatestRetrieveOutput = Awaited<ReturnType<typeof posthog.wizardSessionsLatestRetrieve>>;
|
|
127
|
+
|
|
128
|
+
const result: WizardSessionsLatestRetrieveOutput = await posthog.wizardSessionsLatestRetrieve();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { session_id: string; team_id: number; workflow_id: string; skill_id: string; started_at: string; run_phase: "idle" | "running" | "completed" | "error"; tasks: ({ id: string; title: string; status: "pending" | "in_progr...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.wizardSessionsStreamRetrieve`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `GET /api/projects/{project_id}/wizard/sessions/stream/`
|
|
136
|
+
- **What it does**: Server-Sent Events stream of wizard session updates for a (workflow_id, skill_id) pair. On connect, the current latest session (if any) is emitted as the first event; subsequent upserts are streamed in real time. The server closes the connection after 900 seconds with an `event: end` line so the client (EventSource) can reconnect.
|
|
137
|
+
|
|
138
|
+
**SDK consumers**: do not call the generated fetch wrapper for this path — it will buffer the entire infinite stream. Use the URL builder (`getWizardSessionsStreamRetrieveUrl`) with the browser's `EventSource` API instead.
|
|
139
|
+
- **OpenAPI operationId**: `wizard_sessions_stream_retrieve`
|
|
140
|
+
- **Path params**: None
|
|
141
|
+
- **Query params**: `skill_id`, `workflow_id`
|
|
142
|
+
- **Response codes**: `200`
|
|
143
|
+
- **Transport options**: None
|
|
144
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
145
|
+
|
|
146
|
+
**Inputs**
|
|
147
|
+
|
|
148
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
149
|
+
- Client transport options: None
|
|
150
|
+
|
|
151
|
+
**Outputs**
|
|
152
|
+
|
|
153
|
+
- Client return type: `string`
|
|
154
|
+
- OpenAPI response codes: `200`
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
import posthog from "@utdk/posthog";
|
|
158
|
+
|
|
159
|
+
type WizardSessionsStreamRetrieveInput = Parameters<typeof posthog.wizardSessionsStreamRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
160
|
+
type WizardSessionsStreamRetrieveOutput = Awaited<ReturnType<typeof posthog.wizardSessionsStreamRetrieve>>;
|
|
161
|
+
|
|
162
|
+
const result: WizardSessionsStreamRetrieveOutput = await posthog.wizardSessionsStreamRetrieve();
|
|
163
|
+
|
|
164
|
+
// Result shape (from schema): string
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<!-- prompt-hash:
|
|
169
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
170
|
+
-->
|
package/index.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { CreateClientOptions } from "../client.js";
|
|
2
|
+
import { createClient, createLazyClient } from "../client.js";
|
|
3
|
+
import type { PosthogClient } from "./types/index.js";
|
|
4
|
+
import { toolMetadata } from "./metadata.js";
|
|
5
|
+
import openApiDocument from "./openapi.json" with { type: "json" };
|
|
6
|
+
|
|
7
|
+
export * from "./types/index.js";
|
|
8
|
+
|
|
9
|
+
export function createPosthogClient(
|
|
10
|
+
options: Omit<CreateClientOptions, "name" | "openApiDocument" | "toolMetadata"> = {},
|
|
11
|
+
): Promise<PosthogClient> {
|
|
12
|
+
return createClient<PosthogClient>({
|
|
13
|
+
...options,
|
|
14
|
+
name: "posthog",
|
|
15
|
+
openApiDocument,
|
|
16
|
+
toolMetadata,
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const defaultClient = createLazyClient(() => createPosthogClient());
|
|
21
|
+
|
|
22
|
+
export default defaultClient;
|