@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,928 @@
|
|
|
1
|
+
# Data Warehouse
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsDataWarehouseCheckDatabaseNameRetrieve`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/check-database-name/`
|
|
8
|
+
- **What it does**: Check if a database name is available.
|
|
9
|
+
- **OpenAPI operationId**: `environments_data_warehouse_check_database_name_retrieve`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `name`
|
|
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: `{ name: string; available: boolean }`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type EnvironmentsDataWarehouseCheckDatabaseNameRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseCheckDatabaseNameRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type EnvironmentsDataWarehouseCheckDatabaseNameRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseCheckDatabaseNameRetrieve>>;
|
|
31
|
+
|
|
32
|
+
const result: EnvironmentsDataWarehouseCheckDatabaseNameRetrieveOutput = await posthog.environmentsDataWarehouseCheckDatabaseNameRetrieve();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { name: string; available: boolean }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.environmentsDataWarehouseCompletedActivityRetrieve`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/completed_activity/`
|
|
40
|
+
- **What it does**: Returns completed/non-running activities (jobs with status 'Completed').
|
|
41
|
+
Supports pagination and cutoff time filtering.
|
|
42
|
+
- **OpenAPI operationId**: `environments_data_warehouse_completed_activity_retrieve`
|
|
43
|
+
- **Path params**: None
|
|
44
|
+
- **Query params**: None
|
|
45
|
+
- **Response codes**: `200`
|
|
46
|
+
- **Transport options**: None
|
|
47
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
48
|
+
|
|
49
|
+
**Inputs**
|
|
50
|
+
|
|
51
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
52
|
+
- Client transport options: None
|
|
53
|
+
|
|
54
|
+
**Outputs**
|
|
55
|
+
|
|
56
|
+
- Client return type: `unknown`
|
|
57
|
+
- OpenAPI response codes: `200`
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
import posthog from "@utdk/posthog";
|
|
61
|
+
|
|
62
|
+
type EnvironmentsDataWarehouseCompletedActivityRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseCompletedActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
63
|
+
type EnvironmentsDataWarehouseCompletedActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseCompletedActivityRetrieve>>;
|
|
64
|
+
|
|
65
|
+
const result: EnvironmentsDataWarehouseCompletedActivityRetrieveOutput = await posthog.environmentsDataWarehouseCompletedActivityRetrieve();
|
|
66
|
+
|
|
67
|
+
// Result shape (from schema): unknown
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### `posthog.environmentsDataWarehouseDataHealthIssuesRetrieve`
|
|
71
|
+
|
|
72
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/data_health_issues/`
|
|
73
|
+
- **What it does**: Returns failed/disabled data pipeline items for the Pipeline status side panel.
|
|
74
|
+
Includes: materializations, syncs, sources, destinations, and transformations.
|
|
75
|
+
- **OpenAPI operationId**: `environments_data_warehouse_data_health_issues_retrieve`
|
|
76
|
+
- **Path params**: None
|
|
77
|
+
- **Query params**: None
|
|
78
|
+
- **Response codes**: `200`
|
|
79
|
+
- **Transport options**: None
|
|
80
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
81
|
+
|
|
82
|
+
**Inputs**
|
|
83
|
+
|
|
84
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
85
|
+
- Client transport options: None
|
|
86
|
+
|
|
87
|
+
**Outputs**
|
|
88
|
+
|
|
89
|
+
- Client return type: `unknown`
|
|
90
|
+
- OpenAPI response codes: `200`
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
import posthog from "@utdk/posthog";
|
|
94
|
+
|
|
95
|
+
type EnvironmentsDataWarehouseDataHealthIssuesRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseDataHealthIssuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
96
|
+
type EnvironmentsDataWarehouseDataHealthIssuesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseDataHealthIssuesRetrieve>>;
|
|
97
|
+
|
|
98
|
+
const result: EnvironmentsDataWarehouseDataHealthIssuesRetrieveOutput = await posthog.environmentsDataWarehouseDataHealthIssuesRetrieve();
|
|
99
|
+
|
|
100
|
+
// Result shape (from schema): unknown
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### `posthog.environmentsDataWarehouseDataOpsDashboardRetrieve`
|
|
104
|
+
|
|
105
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/data_ops_dashboard/`
|
|
106
|
+
- **What it does**: Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
|
|
107
|
+
- **OpenAPI operationId**: `environments_data_warehouse_data_ops_dashboard_retrieve`
|
|
108
|
+
- **Path params**: None
|
|
109
|
+
- **Query params**: None
|
|
110
|
+
- **Response codes**: `200`
|
|
111
|
+
- **Transport options**: None
|
|
112
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
113
|
+
|
|
114
|
+
**Inputs**
|
|
115
|
+
|
|
116
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
117
|
+
- Client transport options: None
|
|
118
|
+
|
|
119
|
+
**Outputs**
|
|
120
|
+
|
|
121
|
+
- Client return type: `unknown`
|
|
122
|
+
- OpenAPI response codes: `200`
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
import posthog from "@utdk/posthog";
|
|
126
|
+
|
|
127
|
+
type EnvironmentsDataWarehouseDataOpsDashboardRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseDataOpsDashboardRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
128
|
+
type EnvironmentsDataWarehouseDataOpsDashboardRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseDataOpsDashboardRetrieve>>;
|
|
129
|
+
|
|
130
|
+
const result: EnvironmentsDataWarehouseDataOpsDashboardRetrieveOutput = await posthog.environmentsDataWarehouseDataOpsDashboardRetrieve();
|
|
131
|
+
|
|
132
|
+
// Result shape (from schema): unknown
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### `posthog.environmentsDataWarehouseDeleteOrgDestroy`
|
|
136
|
+
|
|
137
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/data_warehouse/delete-org/`
|
|
138
|
+
- **What it does**: Remove the organization's provisioning record after teardown, freeing its warehouse name.
|
|
139
|
+
|
|
140
|
+
Called once the warehouse status reports `deleted`: deprovision tears the warehouse
|
|
141
|
+
down, this removes the now-empty org row so the database_name can be reused. Restricted
|
|
142
|
+
to organization admins.
|
|
143
|
+
- **OpenAPI operationId**: `environments_data_warehouse_delete_org_destroy`
|
|
144
|
+
- **Path params**: None
|
|
145
|
+
- **Query params**: None
|
|
146
|
+
- **Response codes**: `200`
|
|
147
|
+
- **Transport options**: None
|
|
148
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
149
|
+
|
|
150
|
+
**Inputs**
|
|
151
|
+
|
|
152
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
153
|
+
- Client transport options: None
|
|
154
|
+
|
|
155
|
+
**Outputs**
|
|
156
|
+
|
|
157
|
+
- Client return type: `{ status?: string; org?: string }`
|
|
158
|
+
- OpenAPI response codes: `200`
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
import posthog from "@utdk/posthog";
|
|
162
|
+
|
|
163
|
+
type EnvironmentsDataWarehouseDeleteOrgDestroyInput = Parameters<typeof posthog.environmentsDataWarehouseDeleteOrgDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
164
|
+
type EnvironmentsDataWarehouseDeleteOrgDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseDeleteOrgDestroy>>;
|
|
165
|
+
|
|
166
|
+
const result: EnvironmentsDataWarehouseDeleteOrgDestroyOutput = await posthog.environmentsDataWarehouseDeleteOrgDestroy();
|
|
167
|
+
|
|
168
|
+
// Result shape (from schema): { status?: string; org?: string }
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### `posthog.environmentsDataWarehouseDeprovisionCreate`
|
|
172
|
+
|
|
173
|
+
- **HTTP**: `POST /api/environments/{environment_id}/data_warehouse/deprovision/`
|
|
174
|
+
- **What it does**: Start deprovisioning the organization's managed warehouse. Restricted to organization admins.
|
|
175
|
+
- **OpenAPI operationId**: `environments_data_warehouse_deprovision_create`
|
|
176
|
+
- **Path params**: None
|
|
177
|
+
- **Query params**: None
|
|
178
|
+
- **Response codes**: `202`
|
|
179
|
+
- **Transport options**: None
|
|
180
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
181
|
+
|
|
182
|
+
**Inputs**
|
|
183
|
+
|
|
184
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
185
|
+
- Client transport options: None
|
|
186
|
+
|
|
187
|
+
**Outputs**
|
|
188
|
+
|
|
189
|
+
- Client return type: `unknown`
|
|
190
|
+
- OpenAPI response codes: `202`
|
|
191
|
+
|
|
192
|
+
```ts
|
|
193
|
+
import posthog from "@utdk/posthog";
|
|
194
|
+
|
|
195
|
+
type EnvironmentsDataWarehouseDeprovisionCreateInput = Parameters<typeof posthog.environmentsDataWarehouseDeprovisionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
196
|
+
type EnvironmentsDataWarehouseDeprovisionCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseDeprovisionCreate>>;
|
|
197
|
+
|
|
198
|
+
const result: EnvironmentsDataWarehouseDeprovisionCreateOutput = await posthog.environmentsDataWarehouseDeprovisionCreate();
|
|
199
|
+
|
|
200
|
+
// Result shape (from schema): unknown
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### `posthog.environmentsDataWarehouseEnableBackfillCreate`
|
|
204
|
+
|
|
205
|
+
- **HTTP**: `POST /api/environments/{environment_id}/data_warehouse/enable_backfill/`
|
|
206
|
+
- **What it does**: Enable warehouse backfill for this environment with a dedicated set of tables.
|
|
207
|
+
|
|
208
|
+
Requires a table name and records the environment's membership in the
|
|
209
|
+
organization's managed warehouse. Restricted to organization admins.
|
|
210
|
+
- **OpenAPI operationId**: `environments_data_warehouse_enable_backfill_create`
|
|
211
|
+
- **Path params**: None
|
|
212
|
+
- **Query params**: None
|
|
213
|
+
- **Response codes**: `200`
|
|
214
|
+
- **Transport options**: None
|
|
215
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
216
|
+
|
|
217
|
+
**Inputs**
|
|
218
|
+
|
|
219
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
220
|
+
- Client transport options: None
|
|
221
|
+
|
|
222
|
+
**Outputs**
|
|
223
|
+
|
|
224
|
+
- Client return type: `{ enabled: boolean; table_suffix: string }`
|
|
225
|
+
- OpenAPI response codes: `200`
|
|
226
|
+
|
|
227
|
+
```ts
|
|
228
|
+
import posthog from "@utdk/posthog";
|
|
229
|
+
|
|
230
|
+
type EnvironmentsDataWarehouseEnableBackfillCreateInput = Parameters<typeof posthog.environmentsDataWarehouseEnableBackfillCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
231
|
+
type EnvironmentsDataWarehouseEnableBackfillCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseEnableBackfillCreate>>;
|
|
232
|
+
|
|
233
|
+
const result: EnvironmentsDataWarehouseEnableBackfillCreateOutput = await posthog.environmentsDataWarehouseEnableBackfillCreate();
|
|
234
|
+
|
|
235
|
+
// Result shape (from schema): { enabled: boolean; table_suffix: string }
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### `posthog.environmentsDataWarehouseJobStatsRetrieve`
|
|
239
|
+
|
|
240
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/job_stats/`
|
|
241
|
+
- **What it does**: Returns success and failed job statistics for the last 1, 7, or 30 days.
|
|
242
|
+
Query parameter 'days' can be 1, 7, or 30 (default: 7).
|
|
243
|
+
- **OpenAPI operationId**: `environments_data_warehouse_job_stats_retrieve`
|
|
244
|
+
- **Path params**: None
|
|
245
|
+
- **Query params**: None
|
|
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: `unknown`
|
|
258
|
+
- OpenAPI response codes: `200`
|
|
259
|
+
|
|
260
|
+
```ts
|
|
261
|
+
import posthog from "@utdk/posthog";
|
|
262
|
+
|
|
263
|
+
type EnvironmentsDataWarehouseJobStatsRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseJobStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
264
|
+
type EnvironmentsDataWarehouseJobStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseJobStatsRetrieve>>;
|
|
265
|
+
|
|
266
|
+
const result: EnvironmentsDataWarehouseJobStatsRetrieveOutput = await posthog.environmentsDataWarehouseJobStatsRetrieve();
|
|
267
|
+
|
|
268
|
+
// Result shape (from schema): unknown
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### `posthog.environmentsDataWarehousePropertyValuesRetrieve`
|
|
272
|
+
|
|
273
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/property_values/`
|
|
274
|
+
- **What it does**: API endpoints for data warehouse aggregate statistics and operations.
|
|
275
|
+
- **OpenAPI operationId**: `environments_data_warehouse_property_values_retrieve`
|
|
276
|
+
- **Path params**: None
|
|
277
|
+
- **Query params**: None
|
|
278
|
+
- **Response codes**: `200`
|
|
279
|
+
- **Transport options**: None
|
|
280
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
281
|
+
|
|
282
|
+
**Inputs**
|
|
283
|
+
|
|
284
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
285
|
+
- Client transport options: None
|
|
286
|
+
|
|
287
|
+
**Outputs**
|
|
288
|
+
|
|
289
|
+
- Client return type: `unknown`
|
|
290
|
+
- OpenAPI response codes: `200`
|
|
291
|
+
|
|
292
|
+
```ts
|
|
293
|
+
import posthog from "@utdk/posthog";
|
|
294
|
+
|
|
295
|
+
type EnvironmentsDataWarehousePropertyValuesRetrieveInput = Parameters<typeof posthog.environmentsDataWarehousePropertyValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
296
|
+
type EnvironmentsDataWarehousePropertyValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehousePropertyValuesRetrieve>>;
|
|
297
|
+
|
|
298
|
+
const result: EnvironmentsDataWarehousePropertyValuesRetrieveOutput = await posthog.environmentsDataWarehousePropertyValuesRetrieve();
|
|
299
|
+
|
|
300
|
+
// Result shape (from schema): unknown
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### `posthog.environmentsDataWarehouseProvisionCreate`
|
|
304
|
+
|
|
305
|
+
- **HTTP**: `POST /api/environments/{environment_id}/data_warehouse/provision/`
|
|
306
|
+
- **What it does**: Start provisioning a managed warehouse for this organization (shared by all its teams).
|
|
307
|
+
- **OpenAPI operationId**: `environments_data_warehouse_provision_create`
|
|
308
|
+
- **Path params**: None
|
|
309
|
+
- **Query params**: None
|
|
310
|
+
- **Response codes**: `202`
|
|
311
|
+
- **Transport options**: None
|
|
312
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
313
|
+
|
|
314
|
+
**Inputs**
|
|
315
|
+
|
|
316
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
317
|
+
- Client transport options: None
|
|
318
|
+
|
|
319
|
+
**Outputs**
|
|
320
|
+
|
|
321
|
+
- Client return type: `unknown`
|
|
322
|
+
- OpenAPI response codes: `202`
|
|
323
|
+
|
|
324
|
+
```ts
|
|
325
|
+
import posthog from "@utdk/posthog";
|
|
326
|
+
|
|
327
|
+
type EnvironmentsDataWarehouseProvisionCreateInput = Parameters<typeof posthog.environmentsDataWarehouseProvisionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
328
|
+
type EnvironmentsDataWarehouseProvisionCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseProvisionCreate>>;
|
|
329
|
+
|
|
330
|
+
const result: EnvironmentsDataWarehouseProvisionCreateOutput = await posthog.environmentsDataWarehouseProvisionCreate();
|
|
331
|
+
|
|
332
|
+
// Result shape (from schema): unknown
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
### `posthog.environmentsDataWarehouseResetPasswordCreate`
|
|
336
|
+
|
|
337
|
+
- **HTTP**: `POST /api/environments/{environment_id}/data_warehouse/reset-password/`
|
|
338
|
+
- **What it does**: Reset the root password for the managed warehouse.
|
|
339
|
+
- **OpenAPI operationId**: `environments_data_warehouse_reset_password_create`
|
|
340
|
+
- **Path params**: None
|
|
341
|
+
- **Query params**: None
|
|
342
|
+
- **Response codes**: `200`
|
|
343
|
+
- **Transport options**: None
|
|
344
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
345
|
+
|
|
346
|
+
**Inputs**
|
|
347
|
+
|
|
348
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
349
|
+
- Client transport options: None
|
|
350
|
+
|
|
351
|
+
**Outputs**
|
|
352
|
+
|
|
353
|
+
- Client return type: `{ username: string; password: string }`
|
|
354
|
+
- OpenAPI response codes: `200`
|
|
355
|
+
|
|
356
|
+
```ts
|
|
357
|
+
import posthog from "@utdk/posthog";
|
|
358
|
+
|
|
359
|
+
type EnvironmentsDataWarehouseResetPasswordCreateInput = Parameters<typeof posthog.environmentsDataWarehouseResetPasswordCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
360
|
+
type EnvironmentsDataWarehouseResetPasswordCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseResetPasswordCreate>>;
|
|
361
|
+
|
|
362
|
+
const result: EnvironmentsDataWarehouseResetPasswordCreateOutput = await posthog.environmentsDataWarehouseResetPasswordCreate();
|
|
363
|
+
|
|
364
|
+
// Result shape (from schema): { username: string; password: string }
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### `posthog.environmentsDataWarehouseRunningActivityRetrieve`
|
|
368
|
+
|
|
369
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/running_activity/`
|
|
370
|
+
- **What it does**: Returns currently running activities (jobs with status 'Running').
|
|
371
|
+
Supports pagination and cutoff time filtering.
|
|
372
|
+
- **OpenAPI operationId**: `environments_data_warehouse_running_activity_retrieve`
|
|
373
|
+
- **Path params**: None
|
|
374
|
+
- **Query params**: None
|
|
375
|
+
- **Response codes**: `200`
|
|
376
|
+
- **Transport options**: None
|
|
377
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
378
|
+
|
|
379
|
+
**Inputs**
|
|
380
|
+
|
|
381
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
382
|
+
- Client transport options: None
|
|
383
|
+
|
|
384
|
+
**Outputs**
|
|
385
|
+
|
|
386
|
+
- Client return type: `unknown`
|
|
387
|
+
- OpenAPI response codes: `200`
|
|
388
|
+
|
|
389
|
+
```ts
|
|
390
|
+
import posthog from "@utdk/posthog";
|
|
391
|
+
|
|
392
|
+
type EnvironmentsDataWarehouseRunningActivityRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseRunningActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
393
|
+
type EnvironmentsDataWarehouseRunningActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseRunningActivityRetrieve>>;
|
|
394
|
+
|
|
395
|
+
const result: EnvironmentsDataWarehouseRunningActivityRetrieveOutput = await posthog.environmentsDataWarehouseRunningActivityRetrieve();
|
|
396
|
+
|
|
397
|
+
// Result shape (from schema): unknown
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### `posthog.environmentsDataWarehouseTotalRowsStatsRetrieve`
|
|
401
|
+
|
|
402
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/total_rows_stats/`
|
|
403
|
+
- **What it does**: Returns aggregated statistics for the data warehouse total rows processed within the current billing period.
|
|
404
|
+
Used by the frontend data warehouse scene to display usage information.
|
|
405
|
+
- **OpenAPI operationId**: `environments_data_warehouse_total_rows_stats_retrieve`
|
|
406
|
+
- **Path params**: None
|
|
407
|
+
- **Query params**: None
|
|
408
|
+
- **Response codes**: `200`
|
|
409
|
+
- **Transport options**: None
|
|
410
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
411
|
+
|
|
412
|
+
**Inputs**
|
|
413
|
+
|
|
414
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
415
|
+
- Client transport options: None
|
|
416
|
+
|
|
417
|
+
**Outputs**
|
|
418
|
+
|
|
419
|
+
- Client return type: `unknown`
|
|
420
|
+
- OpenAPI response codes: `200`
|
|
421
|
+
|
|
422
|
+
```ts
|
|
423
|
+
import posthog from "@utdk/posthog";
|
|
424
|
+
|
|
425
|
+
type EnvironmentsDataWarehouseTotalRowsStatsRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseTotalRowsStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
426
|
+
type EnvironmentsDataWarehouseTotalRowsStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseTotalRowsStatsRetrieve>>;
|
|
427
|
+
|
|
428
|
+
const result: EnvironmentsDataWarehouseTotalRowsStatsRetrieveOutput = await posthog.environmentsDataWarehouseTotalRowsStatsRetrieve();
|
|
429
|
+
|
|
430
|
+
// Result shape (from schema): unknown
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### `posthog.environmentsDataWarehouseWarehouseStatusRetrieve`
|
|
434
|
+
|
|
435
|
+
- **HTTP**: `GET /api/environments/{environment_id}/data_warehouse/warehouse_status/`
|
|
436
|
+
- **What it does**: Get the current provisioning status of the managed warehouse, with this project's backfill state.
|
|
437
|
+
- **OpenAPI operationId**: `environments_data_warehouse_warehouse_status_retrieve`
|
|
438
|
+
- **Path params**: None
|
|
439
|
+
- **Query params**: None
|
|
440
|
+
- **Response codes**: `200`
|
|
441
|
+
- **Transport options**: None
|
|
442
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
443
|
+
|
|
444
|
+
**Inputs**
|
|
445
|
+
|
|
446
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
447
|
+
- Client transport options: None
|
|
448
|
+
|
|
449
|
+
**Outputs**
|
|
450
|
+
|
|
451
|
+
- Client return type: `{ org_id: string; state: "pending" | "provisioning" | "ready" | "failed" | "deleting" | "deleted"; status_message: string; s3_state: string; metadata_store_state: string; identity_state: string; secrets_state: string; r...`
|
|
452
|
+
- OpenAPI response codes: `200`
|
|
453
|
+
|
|
454
|
+
```ts
|
|
455
|
+
import posthog from "@utdk/posthog";
|
|
456
|
+
|
|
457
|
+
type EnvironmentsDataWarehouseWarehouseStatusRetrieveInput = Parameters<typeof posthog.environmentsDataWarehouseWarehouseStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
458
|
+
type EnvironmentsDataWarehouseWarehouseStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataWarehouseWarehouseStatusRetrieve>>;
|
|
459
|
+
|
|
460
|
+
const result: EnvironmentsDataWarehouseWarehouseStatusRetrieveOutput = await posthog.environmentsDataWarehouseWarehouseStatusRetrieve();
|
|
461
|
+
|
|
462
|
+
// Result shape (from schema): { org_id: string; state: "pending" | "provisioning" | "ready" | "failed" | "deleting" | "deleted"; status_message: string; s3_state: string; metadata_store_state: string; identity_state: string; secrets_state: string; r...
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
### `posthog.dataWarehouseCheckDatabaseNameRetrieve`
|
|
466
|
+
|
|
467
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/check-database-name/`
|
|
468
|
+
- **What it does**: Check if a database name is available.
|
|
469
|
+
- **OpenAPI operationId**: `data_warehouse_check_database_name_retrieve`
|
|
470
|
+
- **Path params**: None
|
|
471
|
+
- **Query params**: `name`
|
|
472
|
+
- **Response codes**: `200`
|
|
473
|
+
- **Transport options**: None
|
|
474
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
475
|
+
|
|
476
|
+
**Inputs**
|
|
477
|
+
|
|
478
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
479
|
+
- Client transport options: None
|
|
480
|
+
|
|
481
|
+
**Outputs**
|
|
482
|
+
|
|
483
|
+
- Client return type: `{ name: string; available: boolean }`
|
|
484
|
+
- OpenAPI response codes: `200`
|
|
485
|
+
|
|
486
|
+
```ts
|
|
487
|
+
import posthog from "@utdk/posthog";
|
|
488
|
+
|
|
489
|
+
type DataWarehouseCheckDatabaseNameRetrieveInput = Parameters<typeof posthog.dataWarehouseCheckDatabaseNameRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
490
|
+
type DataWarehouseCheckDatabaseNameRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseCheckDatabaseNameRetrieve>>;
|
|
491
|
+
|
|
492
|
+
const result: DataWarehouseCheckDatabaseNameRetrieveOutput = await posthog.dataWarehouseCheckDatabaseNameRetrieve();
|
|
493
|
+
|
|
494
|
+
// Result shape (from schema): { name: string; available: boolean }
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### `posthog.dataWarehouseCompletedActivityRetrieve`
|
|
498
|
+
|
|
499
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/completed_activity/`
|
|
500
|
+
- **What it does**: Returns completed/non-running activities (jobs with status 'Completed').
|
|
501
|
+
Supports pagination and cutoff time filtering.
|
|
502
|
+
- **OpenAPI operationId**: `data_warehouse_completed_activity_retrieve`
|
|
503
|
+
- **Path params**: None
|
|
504
|
+
- **Query params**: None
|
|
505
|
+
- **Response codes**: `200`
|
|
506
|
+
- **Transport options**: None
|
|
507
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
508
|
+
|
|
509
|
+
**Inputs**
|
|
510
|
+
|
|
511
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
512
|
+
- Client transport options: None
|
|
513
|
+
|
|
514
|
+
**Outputs**
|
|
515
|
+
|
|
516
|
+
- Client return type: `unknown`
|
|
517
|
+
- OpenAPI response codes: `200`
|
|
518
|
+
|
|
519
|
+
```ts
|
|
520
|
+
import posthog from "@utdk/posthog";
|
|
521
|
+
|
|
522
|
+
type DataWarehouseCompletedActivityRetrieveInput = Parameters<typeof posthog.dataWarehouseCompletedActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
523
|
+
type DataWarehouseCompletedActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseCompletedActivityRetrieve>>;
|
|
524
|
+
|
|
525
|
+
const result: DataWarehouseCompletedActivityRetrieveOutput = await posthog.dataWarehouseCompletedActivityRetrieve();
|
|
526
|
+
|
|
527
|
+
// Result shape (from schema): unknown
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
### `posthog.dataWarehouseDataHealthIssuesRetrieve`
|
|
531
|
+
|
|
532
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/data_health_issues/`
|
|
533
|
+
- **What it does**: Returns failed/disabled data pipeline items for the Pipeline status side panel.
|
|
534
|
+
Includes: materializations, syncs, sources, destinations, and transformations.
|
|
535
|
+
- **OpenAPI operationId**: `data_warehouse_data_health_issues_retrieve`
|
|
536
|
+
- **Path params**: None
|
|
537
|
+
- **Query params**: None
|
|
538
|
+
- **Response codes**: `200`
|
|
539
|
+
- **Transport options**: None
|
|
540
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
541
|
+
|
|
542
|
+
**Inputs**
|
|
543
|
+
|
|
544
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
545
|
+
- Client transport options: None
|
|
546
|
+
|
|
547
|
+
**Outputs**
|
|
548
|
+
|
|
549
|
+
- Client return type: `unknown`
|
|
550
|
+
- OpenAPI response codes: `200`
|
|
551
|
+
|
|
552
|
+
```ts
|
|
553
|
+
import posthog from "@utdk/posthog";
|
|
554
|
+
|
|
555
|
+
type DataWarehouseDataHealthIssuesRetrieveInput = Parameters<typeof posthog.dataWarehouseDataHealthIssuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
556
|
+
type DataWarehouseDataHealthIssuesRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseDataHealthIssuesRetrieve>>;
|
|
557
|
+
|
|
558
|
+
const result: DataWarehouseDataHealthIssuesRetrieveOutput = await posthog.dataWarehouseDataHealthIssuesRetrieve();
|
|
559
|
+
|
|
560
|
+
// Result shape (from schema): unknown
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
### `posthog.dataWarehouseDataOpsDashboardRetrieve`
|
|
564
|
+
|
|
565
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/data_ops_dashboard/`
|
|
566
|
+
- **What it does**: Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
|
|
567
|
+
- **OpenAPI operationId**: `data_warehouse_data_ops_dashboard_retrieve`
|
|
568
|
+
- **Path params**: None
|
|
569
|
+
- **Query params**: None
|
|
570
|
+
- **Response codes**: `200`
|
|
571
|
+
- **Transport options**: None
|
|
572
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
573
|
+
|
|
574
|
+
**Inputs**
|
|
575
|
+
|
|
576
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
577
|
+
- Client transport options: None
|
|
578
|
+
|
|
579
|
+
**Outputs**
|
|
580
|
+
|
|
581
|
+
- Client return type: `unknown`
|
|
582
|
+
- OpenAPI response codes: `200`
|
|
583
|
+
|
|
584
|
+
```ts
|
|
585
|
+
import posthog from "@utdk/posthog";
|
|
586
|
+
|
|
587
|
+
type DataWarehouseDataOpsDashboardRetrieveInput = Parameters<typeof posthog.dataWarehouseDataOpsDashboardRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
588
|
+
type DataWarehouseDataOpsDashboardRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseDataOpsDashboardRetrieve>>;
|
|
589
|
+
|
|
590
|
+
const result: DataWarehouseDataOpsDashboardRetrieveOutput = await posthog.dataWarehouseDataOpsDashboardRetrieve();
|
|
591
|
+
|
|
592
|
+
// Result shape (from schema): unknown
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
### `posthog.dataWarehouseDeleteOrgDestroy`
|
|
596
|
+
|
|
597
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/data_warehouse/delete-org/`
|
|
598
|
+
- **What it does**: Remove the organization's provisioning record after teardown, freeing its warehouse name.
|
|
599
|
+
|
|
600
|
+
Called once the warehouse status reports `deleted`: deprovision tears the warehouse
|
|
601
|
+
down, this removes the now-empty org row so the database_name can be reused. Restricted
|
|
602
|
+
to organization admins.
|
|
603
|
+
- **OpenAPI operationId**: `data_warehouse_delete_org_destroy`
|
|
604
|
+
- **Path params**: None
|
|
605
|
+
- **Query params**: None
|
|
606
|
+
- **Response codes**: `200`
|
|
607
|
+
- **Transport options**: None
|
|
608
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
609
|
+
|
|
610
|
+
**Inputs**
|
|
611
|
+
|
|
612
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
613
|
+
- Client transport options: None
|
|
614
|
+
|
|
615
|
+
**Outputs**
|
|
616
|
+
|
|
617
|
+
- Client return type: `{ status?: string; org?: string }`
|
|
618
|
+
- OpenAPI response codes: `200`
|
|
619
|
+
|
|
620
|
+
```ts
|
|
621
|
+
import posthog from "@utdk/posthog";
|
|
622
|
+
|
|
623
|
+
type DataWarehouseDeleteOrgDestroyInput = Parameters<typeof posthog.dataWarehouseDeleteOrgDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
624
|
+
type DataWarehouseDeleteOrgDestroyOutput = Awaited<ReturnType<typeof posthog.dataWarehouseDeleteOrgDestroy>>;
|
|
625
|
+
|
|
626
|
+
const result: DataWarehouseDeleteOrgDestroyOutput = await posthog.dataWarehouseDeleteOrgDestroy();
|
|
627
|
+
|
|
628
|
+
// Result shape (from schema): { status?: string; org?: string }
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### `posthog.dataWarehouseDeprovisionCreate`
|
|
632
|
+
|
|
633
|
+
- **HTTP**: `POST /api/projects/{project_id}/data_warehouse/deprovision/`
|
|
634
|
+
- **What it does**: Start deprovisioning the organization's managed warehouse. Restricted to organization admins.
|
|
635
|
+
- **OpenAPI operationId**: `data_warehouse_deprovision_create`
|
|
636
|
+
- **Path params**: None
|
|
637
|
+
- **Query params**: None
|
|
638
|
+
- **Response codes**: `202`
|
|
639
|
+
- **Transport options**: None
|
|
640
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
641
|
+
|
|
642
|
+
**Inputs**
|
|
643
|
+
|
|
644
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
645
|
+
- Client transport options: None
|
|
646
|
+
|
|
647
|
+
**Outputs**
|
|
648
|
+
|
|
649
|
+
- Client return type: `unknown`
|
|
650
|
+
- OpenAPI response codes: `202`
|
|
651
|
+
|
|
652
|
+
```ts
|
|
653
|
+
import posthog from "@utdk/posthog";
|
|
654
|
+
|
|
655
|
+
type DataWarehouseDeprovisionCreateInput = Parameters<typeof posthog.dataWarehouseDeprovisionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
656
|
+
type DataWarehouseDeprovisionCreateOutput = Awaited<ReturnType<typeof posthog.dataWarehouseDeprovisionCreate>>;
|
|
657
|
+
|
|
658
|
+
const result: DataWarehouseDeprovisionCreateOutput = await posthog.dataWarehouseDeprovisionCreate();
|
|
659
|
+
|
|
660
|
+
// Result shape (from schema): unknown
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
### `posthog.dataWarehouseEnableBackfillCreate`
|
|
664
|
+
|
|
665
|
+
- **HTTP**: `POST /api/projects/{project_id}/data_warehouse/enable_backfill/`
|
|
666
|
+
- **What it does**: Enable warehouse backfill for this environment with a dedicated set of tables.
|
|
667
|
+
|
|
668
|
+
Requires a table name and records the environment's membership in the
|
|
669
|
+
organization's managed warehouse. Restricted to organization admins.
|
|
670
|
+
- **OpenAPI operationId**: `data_warehouse_enable_backfill_create`
|
|
671
|
+
- **Path params**: None
|
|
672
|
+
- **Query params**: None
|
|
673
|
+
- **Response codes**: `200`
|
|
674
|
+
- **Transport options**: None
|
|
675
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
676
|
+
|
|
677
|
+
**Inputs**
|
|
678
|
+
|
|
679
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
680
|
+
- Client transport options: None
|
|
681
|
+
|
|
682
|
+
**Outputs**
|
|
683
|
+
|
|
684
|
+
- Client return type: `{ enabled: boolean; table_suffix: string }`
|
|
685
|
+
- OpenAPI response codes: `200`
|
|
686
|
+
|
|
687
|
+
```ts
|
|
688
|
+
import posthog from "@utdk/posthog";
|
|
689
|
+
|
|
690
|
+
type DataWarehouseEnableBackfillCreateInput = Parameters<typeof posthog.dataWarehouseEnableBackfillCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
691
|
+
type DataWarehouseEnableBackfillCreateOutput = Awaited<ReturnType<typeof posthog.dataWarehouseEnableBackfillCreate>>;
|
|
692
|
+
|
|
693
|
+
const result: DataWarehouseEnableBackfillCreateOutput = await posthog.dataWarehouseEnableBackfillCreate();
|
|
694
|
+
|
|
695
|
+
// Result shape (from schema): { enabled: boolean; table_suffix: string }
|
|
696
|
+
```
|
|
697
|
+
|
|
698
|
+
### `posthog.dataWarehouseJobStatsRetrieve`
|
|
699
|
+
|
|
700
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/job_stats/`
|
|
701
|
+
- **What it does**: Returns success and failed job statistics for the last 1, 7, or 30 days.
|
|
702
|
+
Query parameter 'days' can be 1, 7, or 30 (default: 7).
|
|
703
|
+
- **OpenAPI operationId**: `data_warehouse_job_stats_retrieve`
|
|
704
|
+
- **Path params**: None
|
|
705
|
+
- **Query params**: None
|
|
706
|
+
- **Response codes**: `200`
|
|
707
|
+
- **Transport options**: None
|
|
708
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
709
|
+
|
|
710
|
+
**Inputs**
|
|
711
|
+
|
|
712
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
713
|
+
- Client transport options: None
|
|
714
|
+
|
|
715
|
+
**Outputs**
|
|
716
|
+
|
|
717
|
+
- Client return type: `unknown`
|
|
718
|
+
- OpenAPI response codes: `200`
|
|
719
|
+
|
|
720
|
+
```ts
|
|
721
|
+
import posthog from "@utdk/posthog";
|
|
722
|
+
|
|
723
|
+
type DataWarehouseJobStatsRetrieveInput = Parameters<typeof posthog.dataWarehouseJobStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
724
|
+
type DataWarehouseJobStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseJobStatsRetrieve>>;
|
|
725
|
+
|
|
726
|
+
const result: DataWarehouseJobStatsRetrieveOutput = await posthog.dataWarehouseJobStatsRetrieve();
|
|
727
|
+
|
|
728
|
+
// Result shape (from schema): unknown
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
### `posthog.dataWarehousePropertyValuesRetrieve`
|
|
732
|
+
|
|
733
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/property_values/`
|
|
734
|
+
- **What it does**: API endpoints for data warehouse aggregate statistics and operations.
|
|
735
|
+
- **OpenAPI operationId**: `data_warehouse_property_values_retrieve`
|
|
736
|
+
- **Path params**: None
|
|
737
|
+
- **Query params**: None
|
|
738
|
+
- **Response codes**: `200`
|
|
739
|
+
- **Transport options**: None
|
|
740
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
741
|
+
|
|
742
|
+
**Inputs**
|
|
743
|
+
|
|
744
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
745
|
+
- Client transport options: None
|
|
746
|
+
|
|
747
|
+
**Outputs**
|
|
748
|
+
|
|
749
|
+
- Client return type: `unknown`
|
|
750
|
+
- OpenAPI response codes: `200`
|
|
751
|
+
|
|
752
|
+
```ts
|
|
753
|
+
import posthog from "@utdk/posthog";
|
|
754
|
+
|
|
755
|
+
type DataWarehousePropertyValuesRetrieveInput = Parameters<typeof posthog.dataWarehousePropertyValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
756
|
+
type DataWarehousePropertyValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehousePropertyValuesRetrieve>>;
|
|
757
|
+
|
|
758
|
+
const result: DataWarehousePropertyValuesRetrieveOutput = await posthog.dataWarehousePropertyValuesRetrieve();
|
|
759
|
+
|
|
760
|
+
// Result shape (from schema): unknown
|
|
761
|
+
```
|
|
762
|
+
|
|
763
|
+
### `posthog.dataWarehouseProvisionCreate`
|
|
764
|
+
|
|
765
|
+
- **HTTP**: `POST /api/projects/{project_id}/data_warehouse/provision/`
|
|
766
|
+
- **What it does**: Start provisioning a managed warehouse for this organization (shared by all its teams).
|
|
767
|
+
- **OpenAPI operationId**: `data_warehouse_provision_create`
|
|
768
|
+
- **Path params**: None
|
|
769
|
+
- **Query params**: None
|
|
770
|
+
- **Response codes**: `202`
|
|
771
|
+
- **Transport options**: None
|
|
772
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
773
|
+
|
|
774
|
+
**Inputs**
|
|
775
|
+
|
|
776
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
777
|
+
- Client transport options: None
|
|
778
|
+
|
|
779
|
+
**Outputs**
|
|
780
|
+
|
|
781
|
+
- Client return type: `unknown`
|
|
782
|
+
- OpenAPI response codes: `202`
|
|
783
|
+
|
|
784
|
+
```ts
|
|
785
|
+
import posthog from "@utdk/posthog";
|
|
786
|
+
|
|
787
|
+
type DataWarehouseProvisionCreateInput = Parameters<typeof posthog.dataWarehouseProvisionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
788
|
+
type DataWarehouseProvisionCreateOutput = Awaited<ReturnType<typeof posthog.dataWarehouseProvisionCreate>>;
|
|
789
|
+
|
|
790
|
+
const result: DataWarehouseProvisionCreateOutput = await posthog.dataWarehouseProvisionCreate();
|
|
791
|
+
|
|
792
|
+
// Result shape (from schema): unknown
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### `posthog.dataWarehouseResetPasswordCreate`
|
|
796
|
+
|
|
797
|
+
- **HTTP**: `POST /api/projects/{project_id}/data_warehouse/reset-password/`
|
|
798
|
+
- **What it does**: Reset the root password for the managed warehouse.
|
|
799
|
+
- **OpenAPI operationId**: `data_warehouse_reset_password_create`
|
|
800
|
+
- **Path params**: None
|
|
801
|
+
- **Query params**: None
|
|
802
|
+
- **Response codes**: `200`
|
|
803
|
+
- **Transport options**: None
|
|
804
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
805
|
+
|
|
806
|
+
**Inputs**
|
|
807
|
+
|
|
808
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
809
|
+
- Client transport options: None
|
|
810
|
+
|
|
811
|
+
**Outputs**
|
|
812
|
+
|
|
813
|
+
- Client return type: `{ username: string; password: string }`
|
|
814
|
+
- OpenAPI response codes: `200`
|
|
815
|
+
|
|
816
|
+
```ts
|
|
817
|
+
import posthog from "@utdk/posthog";
|
|
818
|
+
|
|
819
|
+
type DataWarehouseResetPasswordCreateInput = Parameters<typeof posthog.dataWarehouseResetPasswordCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
820
|
+
type DataWarehouseResetPasswordCreateOutput = Awaited<ReturnType<typeof posthog.dataWarehouseResetPasswordCreate>>;
|
|
821
|
+
|
|
822
|
+
const result: DataWarehouseResetPasswordCreateOutput = await posthog.dataWarehouseResetPasswordCreate();
|
|
823
|
+
|
|
824
|
+
// Result shape (from schema): { username: string; password: string }
|
|
825
|
+
```
|
|
826
|
+
|
|
827
|
+
### `posthog.dataWarehouseRunningActivityRetrieve`
|
|
828
|
+
|
|
829
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/running_activity/`
|
|
830
|
+
- **What it does**: Returns currently running activities (jobs with status 'Running').
|
|
831
|
+
Supports pagination and cutoff time filtering.
|
|
832
|
+
- **OpenAPI operationId**: `data_warehouse_running_activity_retrieve`
|
|
833
|
+
- **Path params**: None
|
|
834
|
+
- **Query params**: None
|
|
835
|
+
- **Response codes**: `200`
|
|
836
|
+
- **Transport options**: None
|
|
837
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
838
|
+
|
|
839
|
+
**Inputs**
|
|
840
|
+
|
|
841
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
842
|
+
- Client transport options: None
|
|
843
|
+
|
|
844
|
+
**Outputs**
|
|
845
|
+
|
|
846
|
+
- Client return type: `unknown`
|
|
847
|
+
- OpenAPI response codes: `200`
|
|
848
|
+
|
|
849
|
+
```ts
|
|
850
|
+
import posthog from "@utdk/posthog";
|
|
851
|
+
|
|
852
|
+
type DataWarehouseRunningActivityRetrieveInput = Parameters<typeof posthog.dataWarehouseRunningActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
853
|
+
type DataWarehouseRunningActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseRunningActivityRetrieve>>;
|
|
854
|
+
|
|
855
|
+
const result: DataWarehouseRunningActivityRetrieveOutput = await posthog.dataWarehouseRunningActivityRetrieve();
|
|
856
|
+
|
|
857
|
+
// Result shape (from schema): unknown
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
### `posthog.dataWarehouseTotalRowsStatsRetrieve`
|
|
861
|
+
|
|
862
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/total_rows_stats/`
|
|
863
|
+
- **What it does**: Returns aggregated statistics for the data warehouse total rows processed within the current billing period.
|
|
864
|
+
Used by the frontend data warehouse scene to display usage information.
|
|
865
|
+
- **OpenAPI operationId**: `data_warehouse_total_rows_stats_retrieve`
|
|
866
|
+
- **Path params**: None
|
|
867
|
+
- **Query params**: None
|
|
868
|
+
- **Response codes**: `200`
|
|
869
|
+
- **Transport options**: None
|
|
870
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
871
|
+
|
|
872
|
+
**Inputs**
|
|
873
|
+
|
|
874
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
875
|
+
- Client transport options: None
|
|
876
|
+
|
|
877
|
+
**Outputs**
|
|
878
|
+
|
|
879
|
+
- Client return type: `unknown`
|
|
880
|
+
- OpenAPI response codes: `200`
|
|
881
|
+
|
|
882
|
+
```ts
|
|
883
|
+
import posthog from "@utdk/posthog";
|
|
884
|
+
|
|
885
|
+
type DataWarehouseTotalRowsStatsRetrieveInput = Parameters<typeof posthog.dataWarehouseTotalRowsStatsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
886
|
+
type DataWarehouseTotalRowsStatsRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseTotalRowsStatsRetrieve>>;
|
|
887
|
+
|
|
888
|
+
const result: DataWarehouseTotalRowsStatsRetrieveOutput = await posthog.dataWarehouseTotalRowsStatsRetrieve();
|
|
889
|
+
|
|
890
|
+
// Result shape (from schema): unknown
|
|
891
|
+
```
|
|
892
|
+
|
|
893
|
+
### `posthog.dataWarehouseWarehouseStatusRetrieve`
|
|
894
|
+
|
|
895
|
+
- **HTTP**: `GET /api/projects/{project_id}/data_warehouse/warehouse_status/`
|
|
896
|
+
- **What it does**: Get the current provisioning status of the managed warehouse, with this project's backfill state.
|
|
897
|
+
- **OpenAPI operationId**: `data_warehouse_warehouse_status_retrieve`
|
|
898
|
+
- **Path params**: None
|
|
899
|
+
- **Query params**: None
|
|
900
|
+
- **Response codes**: `200`
|
|
901
|
+
- **Transport options**: None
|
|
902
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
903
|
+
|
|
904
|
+
**Inputs**
|
|
905
|
+
|
|
906
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
907
|
+
- Client transport options: None
|
|
908
|
+
|
|
909
|
+
**Outputs**
|
|
910
|
+
|
|
911
|
+
- Client return type: `{ org_id: string; state: "pending" | "provisioning" | "ready" | "failed" | "deleting" | "deleted"; status_message: string; s3_state: string; metadata_store_state: string; identity_state: string; secrets_state: string; r...`
|
|
912
|
+
- OpenAPI response codes: `200`
|
|
913
|
+
|
|
914
|
+
```ts
|
|
915
|
+
import posthog from "@utdk/posthog";
|
|
916
|
+
|
|
917
|
+
type DataWarehouseWarehouseStatusRetrieveInput = Parameters<typeof posthog.dataWarehouseWarehouseStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
918
|
+
type DataWarehouseWarehouseStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.dataWarehouseWarehouseStatusRetrieve>>;
|
|
919
|
+
|
|
920
|
+
const result: DataWarehouseWarehouseStatusRetrieveOutput = await posthog.dataWarehouseWarehouseStatusRetrieve();
|
|
921
|
+
|
|
922
|
+
// Result shape (from schema): { org_id: string; state: "pending" | "provisioning" | "ready" | "failed" | "deleting" | "deleted"; status_message: string; s3_state: string; metadata_store_state: string; identity_state: string; secrets_state: string; r...
|
|
923
|
+
```
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
<!-- prompt-hash:
|
|
927
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
928
|
+
-->
|