@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,224 @@
|
|
|
1
|
+
# Warehouse Column Annotations
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.warehouseColumnAnnotationsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_column_annotations/`
|
|
8
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
9
|
+
|
|
10
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
11
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
12
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
13
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_list`
|
|
14
|
+
- **Path params**: None
|
|
15
|
+
- **Query params**: `limit`, `offset`, `table_id`
|
|
16
|
+
- **Response codes**: `200`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_mod...`
|
|
28
|
+
- OpenAPI response codes: `200`
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import posthog from "@utdk/posthog";
|
|
32
|
+
|
|
33
|
+
type WarehouseColumnAnnotationsListInput = Parameters<typeof posthog.warehouseColumnAnnotationsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
34
|
+
type WarehouseColumnAnnotationsListOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsList>>;
|
|
35
|
+
|
|
36
|
+
const result: WarehouseColumnAnnotationsListOutput = await posthog.warehouseColumnAnnotationsList();
|
|
37
|
+
|
|
38
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_mod...
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### `posthog.warehouseColumnAnnotationsCreate`
|
|
42
|
+
|
|
43
|
+
- **HTTP**: `POST /api/projects/{project_id}/warehouse_column_annotations/`
|
|
44
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
45
|
+
|
|
46
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
47
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
48
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
49
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_create`
|
|
50
|
+
- **Path params**: None
|
|
51
|
+
- **Query params**: None
|
|
52
|
+
- **Response codes**: `201`
|
|
53
|
+
- **Transport options**: None
|
|
54
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
55
|
+
|
|
56
|
+
**Inputs**
|
|
57
|
+
|
|
58
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
59
|
+
- Client transport options: None
|
|
60
|
+
|
|
61
|
+
**Outputs**
|
|
62
|
+
|
|
63
|
+
- Client return type: `{ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...`
|
|
64
|
+
- OpenAPI response codes: `201`
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import posthog from "@utdk/posthog";
|
|
68
|
+
|
|
69
|
+
type WarehouseColumnAnnotationsCreateInput = Parameters<typeof posthog.warehouseColumnAnnotationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
70
|
+
type WarehouseColumnAnnotationsCreateOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsCreate>>;
|
|
71
|
+
|
|
72
|
+
const result: WarehouseColumnAnnotationsCreateOutput = await posthog.warehouseColumnAnnotationsCreate();
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### `posthog.warehouseColumnAnnotationsDestroy`
|
|
78
|
+
|
|
79
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/warehouse_column_annotations/{id}/`
|
|
80
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
81
|
+
|
|
82
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
83
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
84
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
85
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_destroy`
|
|
86
|
+
- **Path params**: `id`
|
|
87
|
+
- **Query params**: None
|
|
88
|
+
- **Response codes**: `204`
|
|
89
|
+
- **Transport options**: None
|
|
90
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
91
|
+
|
|
92
|
+
**Inputs**
|
|
93
|
+
|
|
94
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
95
|
+
- Client transport options: None
|
|
96
|
+
|
|
97
|
+
**Outputs**
|
|
98
|
+
|
|
99
|
+
- Client return type: `unknown`
|
|
100
|
+
- OpenAPI response codes: `204`
|
|
101
|
+
|
|
102
|
+
```ts
|
|
103
|
+
import posthog from "@utdk/posthog";
|
|
104
|
+
|
|
105
|
+
type WarehouseColumnAnnotationsDestroyInput = Parameters<typeof posthog.warehouseColumnAnnotationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
106
|
+
type WarehouseColumnAnnotationsDestroyOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsDestroy>>;
|
|
107
|
+
|
|
108
|
+
const result: WarehouseColumnAnnotationsDestroyOutput = await posthog.warehouseColumnAnnotationsDestroy();
|
|
109
|
+
|
|
110
|
+
// Result shape (from schema): unknown
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### `posthog.warehouseColumnAnnotationsRetrieve`
|
|
114
|
+
|
|
115
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_column_annotations/{id}/`
|
|
116
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
117
|
+
|
|
118
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
119
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
120
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
121
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_retrieve`
|
|
122
|
+
- **Path params**: `id`
|
|
123
|
+
- **Query params**: None
|
|
124
|
+
- **Response codes**: `200`
|
|
125
|
+
- **Transport options**: None
|
|
126
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
127
|
+
|
|
128
|
+
**Inputs**
|
|
129
|
+
|
|
130
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
131
|
+
- Client transport options: None
|
|
132
|
+
|
|
133
|
+
**Outputs**
|
|
134
|
+
|
|
135
|
+
- Client return type: `{ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...`
|
|
136
|
+
- OpenAPI response codes: `200`
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
import posthog from "@utdk/posthog";
|
|
140
|
+
|
|
141
|
+
type WarehouseColumnAnnotationsRetrieveInput = Parameters<typeof posthog.warehouseColumnAnnotationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
142
|
+
type WarehouseColumnAnnotationsRetrieveOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsRetrieve>>;
|
|
143
|
+
|
|
144
|
+
const result: WarehouseColumnAnnotationsRetrieveOutput = await posthog.warehouseColumnAnnotationsRetrieve();
|
|
145
|
+
|
|
146
|
+
// Result shape (from schema): { id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### `posthog.warehouseColumnAnnotationsPartialUpdate`
|
|
150
|
+
|
|
151
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/warehouse_column_annotations/{id}/`
|
|
152
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
153
|
+
|
|
154
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
155
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
156
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
157
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_partial_update`
|
|
158
|
+
- **Path params**: `id`
|
|
159
|
+
- **Query params**: None
|
|
160
|
+
- **Response codes**: `200`
|
|
161
|
+
- **Transport options**: None
|
|
162
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
163
|
+
|
|
164
|
+
**Inputs**
|
|
165
|
+
|
|
166
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
167
|
+
- Client transport options: None
|
|
168
|
+
|
|
169
|
+
**Outputs**
|
|
170
|
+
|
|
171
|
+
- Client return type: `{ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...`
|
|
172
|
+
- OpenAPI response codes: `200`
|
|
173
|
+
|
|
174
|
+
```ts
|
|
175
|
+
import posthog from "@utdk/posthog";
|
|
176
|
+
|
|
177
|
+
type WarehouseColumnAnnotationsPartialUpdateInput = Parameters<typeof posthog.warehouseColumnAnnotationsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
178
|
+
type WarehouseColumnAnnotationsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsPartialUpdate>>;
|
|
179
|
+
|
|
180
|
+
const result: WarehouseColumnAnnotationsPartialUpdateOutput = await posthog.warehouseColumnAnnotationsPartialUpdate();
|
|
181
|
+
|
|
182
|
+
// Result shape (from schema): { id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### `posthog.warehouseColumnAnnotationsUpdate`
|
|
186
|
+
|
|
187
|
+
- **HTTP**: `PUT /api/projects/{project_id}/warehouse_column_annotations/{id}/`
|
|
188
|
+
- **What it does**: Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent.
|
|
189
|
+
|
|
190
|
+
List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a
|
|
191
|
+
user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic
|
|
192
|
+
enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
|
|
193
|
+
- **OpenAPI operationId**: `warehouse_column_annotations_update`
|
|
194
|
+
- **Path params**: `id`
|
|
195
|
+
- **Query params**: None
|
|
196
|
+
- **Response codes**: `200`
|
|
197
|
+
- **Transport options**: None
|
|
198
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
199
|
+
|
|
200
|
+
**Inputs**
|
|
201
|
+
|
|
202
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
203
|
+
- Client transport options: None
|
|
204
|
+
|
|
205
|
+
**Outputs**
|
|
206
|
+
|
|
207
|
+
- Client return type: `{ id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...`
|
|
208
|
+
- OpenAPI response codes: `200`
|
|
209
|
+
|
|
210
|
+
```ts
|
|
211
|
+
import posthog from "@utdk/posthog";
|
|
212
|
+
|
|
213
|
+
type WarehouseColumnAnnotationsUpdateInput = Parameters<typeof posthog.warehouseColumnAnnotationsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
214
|
+
type WarehouseColumnAnnotationsUpdateOutput = Awaited<ReturnType<typeof posthog.warehouseColumnAnnotationsUpdate>>;
|
|
215
|
+
|
|
216
|
+
const result: WarehouseColumnAnnotationsUpdateOutput = await posthog.warehouseColumnAnnotationsUpdate();
|
|
217
|
+
|
|
218
|
+
// Result shape (from schema): { id: string; table: string; column_name?: string; description: string; description_source: "canonical" | "ai_generated" | "user_edited"; ai_model: string; is_user_edited: boolean; created_at: string; updated_at: string...
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<!-- prompt-hash:
|
|
223
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
224
|
+
-->
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Warehouse Column Statistics
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.warehouseColumnStatisticsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_column_statistics/`
|
|
8
|
+
- **What it does**: Read per-column data statistics (null fraction, min/max, row count) for warehouse tables.
|
|
9
|
+
|
|
10
|
+
Statistics are computed automatically after a sync and surfaced to the AI agent so it can write
|
|
11
|
+
better queries. They are system-owned and read-only here. List can be filtered to one table with
|
|
12
|
+
`?table_id=<uuid>`.
|
|
13
|
+
- **OpenAPI operationId**: `warehouse_column_statistics_list`
|
|
14
|
+
- **Path params**: None
|
|
15
|
+
- **Query params**: `limit`, `offset`, `table_id`
|
|
16
|
+
- **Response codes**: `200`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; table: string; column_name: string; column_type: string; row_count: number; null_count: number; null_fraction: number; min_value: ...`
|
|
28
|
+
- OpenAPI response codes: `200`
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import posthog from "@utdk/posthog";
|
|
32
|
+
|
|
33
|
+
type WarehouseColumnStatisticsListInput = Parameters<typeof posthog.warehouseColumnStatisticsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
34
|
+
type WarehouseColumnStatisticsListOutput = Awaited<ReturnType<typeof posthog.warehouseColumnStatisticsList>>;
|
|
35
|
+
|
|
36
|
+
const result: WarehouseColumnStatisticsListOutput = await posthog.warehouseColumnStatisticsList();
|
|
37
|
+
|
|
38
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; table: string; column_name: string; column_type: string; row_count: number; null_count: number; null_fraction: number; min_value: ...
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### `posthog.warehouseColumnStatisticsRetrieve`
|
|
42
|
+
|
|
43
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_column_statistics/{id}/`
|
|
44
|
+
- **What it does**: Read per-column data statistics (null fraction, min/max, row count) for warehouse tables.
|
|
45
|
+
|
|
46
|
+
Statistics are computed automatically after a sync and surfaced to the AI agent so it can write
|
|
47
|
+
better queries. They are system-owned and read-only here. List can be filtered to one table with
|
|
48
|
+
`?table_id=<uuid>`.
|
|
49
|
+
- **OpenAPI operationId**: `warehouse_column_statistics_retrieve`
|
|
50
|
+
- **Path params**: `id`
|
|
51
|
+
- **Query params**: None
|
|
52
|
+
- **Response codes**: `200`
|
|
53
|
+
- **Transport options**: None
|
|
54
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
55
|
+
|
|
56
|
+
**Inputs**
|
|
57
|
+
|
|
58
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
59
|
+
- Client transport options: None
|
|
60
|
+
|
|
61
|
+
**Outputs**
|
|
62
|
+
|
|
63
|
+
- Client return type: `{ id: string; table: string; column_name: string; column_type: string; row_count: number; null_count: number; null_fraction: number; min_value: string; max_value: string; has_min_max: boolean; computed_at: string; compu...`
|
|
64
|
+
- OpenAPI response codes: `200`
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import posthog from "@utdk/posthog";
|
|
68
|
+
|
|
69
|
+
type WarehouseColumnStatisticsRetrieveInput = Parameters<typeof posthog.warehouseColumnStatisticsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
70
|
+
type WarehouseColumnStatisticsRetrieveOutput = Awaited<ReturnType<typeof posthog.warehouseColumnStatisticsRetrieve>>;
|
|
71
|
+
|
|
72
|
+
const result: WarehouseColumnStatisticsRetrieveOutput = await posthog.warehouseColumnStatisticsRetrieve();
|
|
73
|
+
|
|
74
|
+
// Result shape (from schema): { id: string; table: string; column_name: string; column_type: string; row_count: number; null_count: number; null_fraction: number; min_value: string; max_value: string; has_min_max: boolean; computed_at: string; compu...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<!-- prompt-hash:
|
|
79
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
80
|
+
-->
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Warehouse Dag
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.warehouseDagList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_dag/`
|
|
8
|
+
- **What it does**: Return this team's DAG as a set of edges and nodes
|
|
9
|
+
- **OpenAPI operationId**: `warehouse_dag_list`
|
|
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: `unknown`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type WarehouseDagListInput = Parameters<typeof posthog.warehouseDagList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type WarehouseDagListOutput = Awaited<ReturnType<typeof posthog.warehouseDagList>>;
|
|
31
|
+
|
|
32
|
+
const result: WarehouseDagListOutput = await posthog.warehouseDagList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): unknown
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<!-- prompt-hash:
|
|
39
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
40
|
+
-->
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Warehouse Model Paths
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.warehouseModelPathsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_model_paths/`
|
|
8
|
+
- **OpenAPI operationId**: `warehouse_model_paths_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: string; path: (string)[]; team: number; table?: string | null; saved_query?: string | null; created_at: string; created_by: { id: number; ...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type WarehouseModelPathsListInput = Parameters<typeof posthog.warehouseModelPathsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type WarehouseModelPathsListOutput = Awaited<ReturnType<typeof posthog.warehouseModelPathsList>>;
|
|
30
|
+
|
|
31
|
+
const result: WarehouseModelPathsListOutput = await posthog.warehouseModelPathsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: (string)[]; team: number; table?: string | null; saved_query?: string | null; created_at: string; created_by: { id: number; ...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.warehouseModelPathsRetrieve`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_model_paths/{id}/`
|
|
39
|
+
- **OpenAPI operationId**: `warehouse_model_paths_retrieve`
|
|
40
|
+
- **Path params**: `id`
|
|
41
|
+
- **Query params**: None
|
|
42
|
+
- **Response codes**: `200`
|
|
43
|
+
- **Transport options**: None
|
|
44
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
45
|
+
|
|
46
|
+
**Inputs**
|
|
47
|
+
|
|
48
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
49
|
+
- Client transport options: None
|
|
50
|
+
|
|
51
|
+
**Outputs**
|
|
52
|
+
|
|
53
|
+
- Client return type: `{ id: string; path: (string)[]; team: number; table?: string | null; saved_query?: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...`
|
|
54
|
+
- OpenAPI response codes: `200`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type WarehouseModelPathsRetrieveInput = Parameters<typeof posthog.warehouseModelPathsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type WarehouseModelPathsRetrieveOutput = Awaited<ReturnType<typeof posthog.warehouseModelPathsRetrieve>>;
|
|
61
|
+
|
|
62
|
+
const result: WarehouseModelPathsRetrieveOutput = await posthog.warehouseModelPathsRetrieve();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; path: (string)[]; team: number; table?: string | null; saved_query?: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<!-- prompt-hash:
|
|
69
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
70
|
+
-->
|