@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,2118 @@
|
|
|
1
|
+
# Batch Exports
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsBatchExportsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_batch_exports_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; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsBatchExportsListInput = Parameters<typeof posthog.environmentsBatchExportsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsBatchExportsListOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsBatchExportsListOutput = await posthog.environmentsBatchExportsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.environmentsBatchExportsCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/`
|
|
39
|
+
- **OpenAPI operationId**: `environments_batch_exports_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: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EnvironmentsBatchExportsCreateInput = Parameters<typeof posthog.environmentsBatchExportsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EnvironmentsBatchExportsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EnvironmentsBatchExportsCreateOutput = await posthog.environmentsBatchExportsCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.environmentsBatchExportsBackfillsList`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/`
|
|
70
|
+
- **What it does**: ViewSet for BatchExportBackfill models.
|
|
71
|
+
|
|
72
|
+
Allows creating and reading backfills, but not updating or deleting them.
|
|
73
|
+
- **OpenAPI operationId**: `environments_batch_exports_backfills_list`
|
|
74
|
+
- **Path params**: `batch_export_id`
|
|
75
|
+
- **Query params**: `cursor`, `ordering`
|
|
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: `{ next?: string | null; previous?: string | null; results: ({ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNe...`
|
|
88
|
+
- OpenAPI response codes: `200`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type EnvironmentsBatchExportsBackfillsListInput = Parameters<typeof posthog.environmentsBatchExportsBackfillsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type EnvironmentsBatchExportsBackfillsListOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsBackfillsList>>;
|
|
95
|
+
|
|
96
|
+
const result: EnvironmentsBatchExportsBackfillsListOutput = await posthog.environmentsBatchExportsBackfillsList();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNe...
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.environmentsBatchExportsBackfillsCreate`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/`
|
|
104
|
+
- **What it does**: Create a new backfill for a BatchExport.
|
|
105
|
+
- **OpenAPI operationId**: `environments_batch_exports_backfills_create`
|
|
106
|
+
- **Path params**: `batch_export_id`
|
|
107
|
+
- **Query params**: None
|
|
108
|
+
- **Response codes**: `201`
|
|
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: `{ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...`
|
|
120
|
+
- OpenAPI response codes: `201`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type EnvironmentsBatchExportsBackfillsCreateInput = Parameters<typeof posthog.environmentsBatchExportsBackfillsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type EnvironmentsBatchExportsBackfillsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsBackfillsCreate>>;
|
|
127
|
+
|
|
128
|
+
const result: EnvironmentsBatchExportsBackfillsCreateOutput = await posthog.environmentsBatchExportsBackfillsCreate();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.environmentsBatchExportsBackfillsRetrieve`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/`
|
|
136
|
+
- **What it does**: ViewSet for BatchExportBackfill models.
|
|
137
|
+
|
|
138
|
+
Allows creating and reading backfills, but not updating or deleting them.
|
|
139
|
+
- **OpenAPI operationId**: `environments_batch_exports_backfills_retrieve`
|
|
140
|
+
- **Path params**: `batch_export_id`, `id`
|
|
141
|
+
- **Query params**: None
|
|
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: `{ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...`
|
|
154
|
+
- OpenAPI response codes: `200`
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
import posthog from "@utdk/posthog";
|
|
158
|
+
|
|
159
|
+
type EnvironmentsBatchExportsBackfillsRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsBackfillsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
160
|
+
type EnvironmentsBatchExportsBackfillsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsBackfillsRetrieve>>;
|
|
161
|
+
|
|
162
|
+
const result: EnvironmentsBatchExportsBackfillsRetrieveOutput = await posthog.environmentsBatchExportsBackfillsRetrieve();
|
|
163
|
+
|
|
164
|
+
// Result shape (from schema): { id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### `posthog.environmentsBatchExportsBackfillsCancelCreate`
|
|
168
|
+
|
|
169
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/`
|
|
170
|
+
- **What it does**: Cancel a batch export backfill.
|
|
171
|
+
- **OpenAPI operationId**: `environments_batch_exports_backfills_cancel_create`
|
|
172
|
+
- **Path params**: `batch_export_id`, `id`
|
|
173
|
+
- **Query params**: None
|
|
174
|
+
- **Response codes**: `200`
|
|
175
|
+
- **Transport options**: None
|
|
176
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
177
|
+
|
|
178
|
+
**Inputs**
|
|
179
|
+
|
|
180
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
181
|
+
- Client transport options: None
|
|
182
|
+
|
|
183
|
+
**Outputs**
|
|
184
|
+
|
|
185
|
+
- Client return type: `unknown`
|
|
186
|
+
- OpenAPI response codes: `200`
|
|
187
|
+
|
|
188
|
+
```ts
|
|
189
|
+
import posthog from "@utdk/posthog";
|
|
190
|
+
|
|
191
|
+
type EnvironmentsBatchExportsBackfillsCancelCreateInput = Parameters<typeof posthog.environmentsBatchExportsBackfillsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
192
|
+
type EnvironmentsBatchExportsBackfillsCancelCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsBackfillsCancelCreate>>;
|
|
193
|
+
|
|
194
|
+
const result: EnvironmentsBatchExportsBackfillsCancelCreateOutput = await posthog.environmentsBatchExportsBackfillsCancelCreate();
|
|
195
|
+
|
|
196
|
+
// Result shape (from schema): unknown
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### `posthog.environmentsBatchExportsRunsList`
|
|
200
|
+
|
|
201
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/`
|
|
202
|
+
- **OpenAPI operationId**: `environments_batch_exports_runs_list`
|
|
203
|
+
- **Path params**: `batch_export_id`
|
|
204
|
+
- **Query params**: `cursor`, `ordering`
|
|
205
|
+
- **Response codes**: `200`
|
|
206
|
+
- **Transport options**: None
|
|
207
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
208
|
+
|
|
209
|
+
**Inputs**
|
|
210
|
+
|
|
211
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
212
|
+
- Client transport options: None
|
|
213
|
+
|
|
214
|
+
**Outputs**
|
|
215
|
+
|
|
216
|
+
- Client return type: `{ next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "...`
|
|
217
|
+
- OpenAPI response codes: `200`
|
|
218
|
+
|
|
219
|
+
```ts
|
|
220
|
+
import posthog from "@utdk/posthog";
|
|
221
|
+
|
|
222
|
+
type EnvironmentsBatchExportsRunsListInput = Parameters<typeof posthog.environmentsBatchExportsRunsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
223
|
+
type EnvironmentsBatchExportsRunsListOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunsList>>;
|
|
224
|
+
|
|
225
|
+
const result: EnvironmentsBatchExportsRunsListOutput = await posthog.environmentsBatchExportsRunsList();
|
|
226
|
+
|
|
227
|
+
// Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "...
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### `posthog.environmentsBatchExportsRunsRetrieve`
|
|
231
|
+
|
|
232
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/`
|
|
233
|
+
- **OpenAPI operationId**: `environments_batch_exports_runs_retrieve`
|
|
234
|
+
- **Path params**: `batch_export_id`, `id`
|
|
235
|
+
- **Query params**: None
|
|
236
|
+
- **Response codes**: `200`
|
|
237
|
+
- **Transport options**: None
|
|
238
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
239
|
+
|
|
240
|
+
**Inputs**
|
|
241
|
+
|
|
242
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
243
|
+
- Client transport options: None
|
|
244
|
+
|
|
245
|
+
**Outputs**
|
|
246
|
+
|
|
247
|
+
- Client return type: `{ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "Starting"; records_completed?: number | null; records_failed...`
|
|
248
|
+
- OpenAPI response codes: `200`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type EnvironmentsBatchExportsRunsRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsRunsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type EnvironmentsBatchExportsRunsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunsRetrieve>>;
|
|
255
|
+
|
|
256
|
+
const result: EnvironmentsBatchExportsRunsRetrieveOutput = await posthog.environmentsBatchExportsRunsRetrieve();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): { id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "Starting"; records_completed?: number | null; records_failed...
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.environmentsBatchExportsRunsCancelCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/`
|
|
264
|
+
- **What it does**: Cancel a batch export run.
|
|
265
|
+
- **OpenAPI operationId**: `environments_batch_exports_runs_cancel_create`
|
|
266
|
+
- **Path params**: `batch_export_id`, `id`
|
|
267
|
+
- **Query params**: None
|
|
268
|
+
- **Response codes**: `200`
|
|
269
|
+
- **Transport options**: None
|
|
270
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
271
|
+
|
|
272
|
+
**Inputs**
|
|
273
|
+
|
|
274
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
275
|
+
- Client transport options: None
|
|
276
|
+
|
|
277
|
+
**Outputs**
|
|
278
|
+
|
|
279
|
+
- Client return type: `unknown`
|
|
280
|
+
- OpenAPI response codes: `200`
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import posthog from "@utdk/posthog";
|
|
284
|
+
|
|
285
|
+
type EnvironmentsBatchExportsRunsCancelCreateInput = Parameters<typeof posthog.environmentsBatchExportsRunsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type EnvironmentsBatchExportsRunsCancelCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunsCancelCreate>>;
|
|
287
|
+
|
|
288
|
+
const result: EnvironmentsBatchExportsRunsCancelCreateOutput = await posthog.environmentsBatchExportsRunsCancelCreate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): unknown
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.environmentsBatchExportsRunsLogsRetrieve`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/logs/`
|
|
296
|
+
- **OpenAPI operationId**: `environments_batch_exports_runs_logs_retrieve`
|
|
297
|
+
- **Path params**: `batch_export_id`, `id`
|
|
298
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
299
|
+
- **Response codes**: `200`
|
|
300
|
+
- **Transport options**: None
|
|
301
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
302
|
+
|
|
303
|
+
**Inputs**
|
|
304
|
+
|
|
305
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
306
|
+
- Client transport options: None
|
|
307
|
+
|
|
308
|
+
**Outputs**
|
|
309
|
+
|
|
310
|
+
- Client return type: `unknown`
|
|
311
|
+
- OpenAPI response codes: `200`
|
|
312
|
+
|
|
313
|
+
```ts
|
|
314
|
+
import posthog from "@utdk/posthog";
|
|
315
|
+
|
|
316
|
+
type EnvironmentsBatchExportsRunsLogsRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsRunsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
317
|
+
type EnvironmentsBatchExportsRunsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunsLogsRetrieve>>;
|
|
318
|
+
|
|
319
|
+
const result: EnvironmentsBatchExportsRunsLogsRetrieveOutput = await posthog.environmentsBatchExportsRunsLogsRetrieve();
|
|
320
|
+
|
|
321
|
+
// Result shape (from schema): unknown
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### `posthog.environmentsBatchExportsRunsRetryCreate`
|
|
325
|
+
|
|
326
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/retry/`
|
|
327
|
+
- **What it does**: Retry a batch export run.
|
|
328
|
+
|
|
329
|
+
We use the same underlying mechanism as when backfilling a batch export, as retrying
|
|
330
|
+
a run is the same as backfilling one run.
|
|
331
|
+
- **OpenAPI operationId**: `environments_batch_exports_runs_retry_create`
|
|
332
|
+
- **Path params**: `batch_export_id`, `id`
|
|
333
|
+
- **Query params**: None
|
|
334
|
+
- **Response codes**: `200`
|
|
335
|
+
- **Transport options**: None
|
|
336
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
337
|
+
|
|
338
|
+
**Inputs**
|
|
339
|
+
|
|
340
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
341
|
+
- Client transport options: None
|
|
342
|
+
|
|
343
|
+
**Outputs**
|
|
344
|
+
|
|
345
|
+
- Client return type: `unknown`
|
|
346
|
+
- OpenAPI response codes: `200`
|
|
347
|
+
|
|
348
|
+
```ts
|
|
349
|
+
import posthog from "@utdk/posthog";
|
|
350
|
+
|
|
351
|
+
type EnvironmentsBatchExportsRunsRetryCreateInput = Parameters<typeof posthog.environmentsBatchExportsRunsRetryCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
352
|
+
type EnvironmentsBatchExportsRunsRetryCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunsRetryCreate>>;
|
|
353
|
+
|
|
354
|
+
const result: EnvironmentsBatchExportsRunsRetryCreateOutput = await posthog.environmentsBatchExportsRunsRetryCreate();
|
|
355
|
+
|
|
356
|
+
// Result shape (from schema): unknown
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
### `posthog.environmentsBatchExportsDestroy`
|
|
360
|
+
|
|
361
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/batch_exports/{id}/`
|
|
362
|
+
- **OpenAPI operationId**: `environments_batch_exports_destroy`
|
|
363
|
+
- **Path params**: `id`
|
|
364
|
+
- **Query params**: None
|
|
365
|
+
- **Response codes**: `204`
|
|
366
|
+
- **Transport options**: None
|
|
367
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
368
|
+
|
|
369
|
+
**Inputs**
|
|
370
|
+
|
|
371
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
372
|
+
- Client transport options: None
|
|
373
|
+
|
|
374
|
+
**Outputs**
|
|
375
|
+
|
|
376
|
+
- Client return type: `unknown`
|
|
377
|
+
- OpenAPI response codes: `204`
|
|
378
|
+
|
|
379
|
+
```ts
|
|
380
|
+
import posthog from "@utdk/posthog";
|
|
381
|
+
|
|
382
|
+
type EnvironmentsBatchExportsDestroyInput = Parameters<typeof posthog.environmentsBatchExportsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
383
|
+
type EnvironmentsBatchExportsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsDestroy>>;
|
|
384
|
+
|
|
385
|
+
const result: EnvironmentsBatchExportsDestroyOutput = await posthog.environmentsBatchExportsDestroy();
|
|
386
|
+
|
|
387
|
+
// Result shape (from schema): unknown
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### `posthog.environmentsBatchExportsRetrieve`
|
|
391
|
+
|
|
392
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{id}/`
|
|
393
|
+
- **OpenAPI operationId**: `environments_batch_exports_retrieve`
|
|
394
|
+
- **Path params**: `id`
|
|
395
|
+
- **Query params**: None
|
|
396
|
+
- **Response codes**: `200`
|
|
397
|
+
- **Transport options**: None
|
|
398
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
399
|
+
|
|
400
|
+
**Inputs**
|
|
401
|
+
|
|
402
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
403
|
+
- Client transport options: None
|
|
404
|
+
|
|
405
|
+
**Outputs**
|
|
406
|
+
|
|
407
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
408
|
+
- OpenAPI response codes: `200`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type EnvironmentsBatchExportsRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type EnvironmentsBatchExportsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRetrieve>>;
|
|
415
|
+
|
|
416
|
+
const result: EnvironmentsBatchExportsRetrieveOutput = await posthog.environmentsBatchExportsRetrieve();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.environmentsBatchExportsPartialUpdate`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/batch_exports/{id}/`
|
|
424
|
+
- **OpenAPI operationId**: `environments_batch_exports_partial_update`
|
|
425
|
+
- **Path params**: `id`
|
|
426
|
+
- **Query params**: None
|
|
427
|
+
- **Response codes**: `200`
|
|
428
|
+
- **Transport options**: None
|
|
429
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
430
|
+
|
|
431
|
+
**Inputs**
|
|
432
|
+
|
|
433
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
434
|
+
- Client transport options: None
|
|
435
|
+
|
|
436
|
+
**Outputs**
|
|
437
|
+
|
|
438
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
439
|
+
- OpenAPI response codes: `200`
|
|
440
|
+
|
|
441
|
+
```ts
|
|
442
|
+
import posthog from "@utdk/posthog";
|
|
443
|
+
|
|
444
|
+
type EnvironmentsBatchExportsPartialUpdateInput = Parameters<typeof posthog.environmentsBatchExportsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
445
|
+
type EnvironmentsBatchExportsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsPartialUpdate>>;
|
|
446
|
+
|
|
447
|
+
const result: EnvironmentsBatchExportsPartialUpdateOutput = await posthog.environmentsBatchExportsPartialUpdate();
|
|
448
|
+
|
|
449
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### `posthog.environmentsBatchExportsUpdate`
|
|
453
|
+
|
|
454
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/batch_exports/{id}/`
|
|
455
|
+
- **OpenAPI operationId**: `environments_batch_exports_update`
|
|
456
|
+
- **Path params**: `id`
|
|
457
|
+
- **Query params**: None
|
|
458
|
+
- **Response codes**: `200`
|
|
459
|
+
- **Transport options**: None
|
|
460
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
461
|
+
|
|
462
|
+
**Inputs**
|
|
463
|
+
|
|
464
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
465
|
+
- Client transport options: None
|
|
466
|
+
|
|
467
|
+
**Outputs**
|
|
468
|
+
|
|
469
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
470
|
+
- OpenAPI response codes: `200`
|
|
471
|
+
|
|
472
|
+
```ts
|
|
473
|
+
import posthog from "@utdk/posthog";
|
|
474
|
+
|
|
475
|
+
type EnvironmentsBatchExportsUpdateInput = Parameters<typeof posthog.environmentsBatchExportsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
476
|
+
type EnvironmentsBatchExportsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsUpdate>>;
|
|
477
|
+
|
|
478
|
+
const result: EnvironmentsBatchExportsUpdateOutput = await posthog.environmentsBatchExportsUpdate();
|
|
479
|
+
|
|
480
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
### `posthog.environmentsBatchExportsLogsRetrieve`
|
|
484
|
+
|
|
485
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/{id}/logs/`
|
|
486
|
+
- **OpenAPI operationId**: `environments_batch_exports_logs_retrieve`
|
|
487
|
+
- **Path params**: `id`
|
|
488
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
489
|
+
- **Response codes**: `200`
|
|
490
|
+
- **Transport options**: None
|
|
491
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
492
|
+
|
|
493
|
+
**Inputs**
|
|
494
|
+
|
|
495
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
496
|
+
- Client transport options: None
|
|
497
|
+
|
|
498
|
+
**Outputs**
|
|
499
|
+
|
|
500
|
+
- Client return type: `unknown`
|
|
501
|
+
- OpenAPI response codes: `200`
|
|
502
|
+
|
|
503
|
+
```ts
|
|
504
|
+
import posthog from "@utdk/posthog";
|
|
505
|
+
|
|
506
|
+
type EnvironmentsBatchExportsLogsRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
507
|
+
type EnvironmentsBatchExportsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsLogsRetrieve>>;
|
|
508
|
+
|
|
509
|
+
const result: EnvironmentsBatchExportsLogsRetrieveOutput = await posthog.environmentsBatchExportsLogsRetrieve();
|
|
510
|
+
|
|
511
|
+
// Result shape (from schema): unknown
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### `posthog.environmentsBatchExportsPauseCreate`
|
|
515
|
+
|
|
516
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{id}/pause/`
|
|
517
|
+
- **What it does**: Pause a BatchExport.
|
|
518
|
+
- **OpenAPI operationId**: `environments_batch_exports_pause_create`
|
|
519
|
+
- **Path params**: `id`
|
|
520
|
+
- **Query params**: None
|
|
521
|
+
- **Response codes**: `200`
|
|
522
|
+
- **Transport options**: None
|
|
523
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
524
|
+
|
|
525
|
+
**Inputs**
|
|
526
|
+
|
|
527
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
528
|
+
- Client transport options: None
|
|
529
|
+
|
|
530
|
+
**Outputs**
|
|
531
|
+
|
|
532
|
+
- Client return type: `unknown`
|
|
533
|
+
- OpenAPI response codes: `200`
|
|
534
|
+
|
|
535
|
+
```ts
|
|
536
|
+
import posthog from "@utdk/posthog";
|
|
537
|
+
|
|
538
|
+
type EnvironmentsBatchExportsPauseCreateInput = Parameters<typeof posthog.environmentsBatchExportsPauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
539
|
+
type EnvironmentsBatchExportsPauseCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsPauseCreate>>;
|
|
540
|
+
|
|
541
|
+
const result: EnvironmentsBatchExportsPauseCreateOutput = await posthog.environmentsBatchExportsPauseCreate();
|
|
542
|
+
|
|
543
|
+
// Result shape (from schema): unknown
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
### `posthog.environmentsBatchExportsRunTestStepCreate`
|
|
547
|
+
|
|
548
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{id}/run_test_step/`
|
|
549
|
+
- **OpenAPI operationId**: `environments_batch_exports_run_test_step_create`
|
|
550
|
+
- **Path params**: `id`
|
|
551
|
+
- **Query params**: None
|
|
552
|
+
- **Response codes**: `200`
|
|
553
|
+
- **Transport options**: None
|
|
554
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
555
|
+
|
|
556
|
+
**Inputs**
|
|
557
|
+
|
|
558
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
559
|
+
- Client transport options: None
|
|
560
|
+
|
|
561
|
+
**Outputs**
|
|
562
|
+
|
|
563
|
+
- Client return type: `unknown`
|
|
564
|
+
- OpenAPI response codes: `200`
|
|
565
|
+
|
|
566
|
+
```ts
|
|
567
|
+
import posthog from "@utdk/posthog";
|
|
568
|
+
|
|
569
|
+
type EnvironmentsBatchExportsRunTestStepCreateInput = Parameters<typeof posthog.environmentsBatchExportsRunTestStepCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
570
|
+
type EnvironmentsBatchExportsRunTestStepCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunTestStepCreate>>;
|
|
571
|
+
|
|
572
|
+
const result: EnvironmentsBatchExportsRunTestStepCreateOutput = await posthog.environmentsBatchExportsRunTestStepCreate();
|
|
573
|
+
|
|
574
|
+
// Result shape (from schema): unknown
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### `posthog.environmentsBatchExportsUnpauseCreate`
|
|
578
|
+
|
|
579
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/{id}/unpause/`
|
|
580
|
+
- **What it does**: Unpause a BatchExport.
|
|
581
|
+
- **OpenAPI operationId**: `environments_batch_exports_unpause_create`
|
|
582
|
+
- **Path params**: `id`
|
|
583
|
+
- **Query params**: None
|
|
584
|
+
- **Response codes**: `200`
|
|
585
|
+
- **Transport options**: None
|
|
586
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
587
|
+
|
|
588
|
+
**Inputs**
|
|
589
|
+
|
|
590
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
591
|
+
- Client transport options: None
|
|
592
|
+
|
|
593
|
+
**Outputs**
|
|
594
|
+
|
|
595
|
+
- Client return type: `unknown`
|
|
596
|
+
- OpenAPI response codes: `200`
|
|
597
|
+
|
|
598
|
+
```ts
|
|
599
|
+
import posthog from "@utdk/posthog";
|
|
600
|
+
|
|
601
|
+
type EnvironmentsBatchExportsUnpauseCreateInput = Parameters<typeof posthog.environmentsBatchExportsUnpauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
602
|
+
type EnvironmentsBatchExportsUnpauseCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsUnpauseCreate>>;
|
|
603
|
+
|
|
604
|
+
const result: EnvironmentsBatchExportsUnpauseCreateOutput = await posthog.environmentsBatchExportsUnpauseCreate();
|
|
605
|
+
|
|
606
|
+
// Result shape (from schema): unknown
|
|
607
|
+
```
|
|
608
|
+
|
|
609
|
+
### `posthog.environmentsBatchExportsRunTestStepNewCreate`
|
|
610
|
+
|
|
611
|
+
- **HTTP**: `POST /api/environments/{environment_id}/batch_exports/run_test_step_new/`
|
|
612
|
+
- **OpenAPI operationId**: `environments_batch_exports_run_test_step_new_create`
|
|
613
|
+
- **Path params**: None
|
|
614
|
+
- **Query params**: None
|
|
615
|
+
- **Response codes**: `200`
|
|
616
|
+
- **Transport options**: None
|
|
617
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
618
|
+
|
|
619
|
+
**Inputs**
|
|
620
|
+
|
|
621
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
622
|
+
- Client transport options: None
|
|
623
|
+
|
|
624
|
+
**Outputs**
|
|
625
|
+
|
|
626
|
+
- Client return type: `unknown`
|
|
627
|
+
- OpenAPI response codes: `200`
|
|
628
|
+
|
|
629
|
+
```ts
|
|
630
|
+
import posthog from "@utdk/posthog";
|
|
631
|
+
|
|
632
|
+
type EnvironmentsBatchExportsRunTestStepNewCreateInput = Parameters<typeof posthog.environmentsBatchExportsRunTestStepNewCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
633
|
+
type EnvironmentsBatchExportsRunTestStepNewCreateOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsRunTestStepNewCreate>>;
|
|
634
|
+
|
|
635
|
+
const result: EnvironmentsBatchExportsRunTestStepNewCreateOutput = await posthog.environmentsBatchExportsRunTestStepNewCreate();
|
|
636
|
+
|
|
637
|
+
// Result shape (from schema): unknown
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
### `posthog.environmentsBatchExportsTestRetrieve`
|
|
641
|
+
|
|
642
|
+
- **HTTP**: `GET /api/environments/{environment_id}/batch_exports/test/`
|
|
643
|
+
- **OpenAPI operationId**: `environments_batch_exports_test_retrieve`
|
|
644
|
+
- **Path params**: None
|
|
645
|
+
- **Query params**: None
|
|
646
|
+
- **Response codes**: `200`
|
|
647
|
+
- **Transport options**: None
|
|
648
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
649
|
+
|
|
650
|
+
**Inputs**
|
|
651
|
+
|
|
652
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
653
|
+
- Client transport options: None
|
|
654
|
+
|
|
655
|
+
**Outputs**
|
|
656
|
+
|
|
657
|
+
- Client return type: `unknown`
|
|
658
|
+
- OpenAPI response codes: `200`
|
|
659
|
+
|
|
660
|
+
```ts
|
|
661
|
+
import posthog from "@utdk/posthog";
|
|
662
|
+
|
|
663
|
+
type EnvironmentsBatchExportsTestRetrieveInput = Parameters<typeof posthog.environmentsBatchExportsTestRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
664
|
+
type EnvironmentsBatchExportsTestRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsBatchExportsTestRetrieve>>;
|
|
665
|
+
|
|
666
|
+
const result: EnvironmentsBatchExportsTestRetrieveOutput = await posthog.environmentsBatchExportsTestRetrieve();
|
|
667
|
+
|
|
668
|
+
// Result shape (from schema): unknown
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### `posthog.environmentsFileDownloadBatchExportsList`
|
|
672
|
+
|
|
673
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_download_batch_exports/`
|
|
674
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_list`
|
|
675
|
+
- **Path params**: None
|
|
676
|
+
- **Query params**: `limit`, `offset`
|
|
677
|
+
- **Response codes**: `200`
|
|
678
|
+
- **Transport options**: None
|
|
679
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
680
|
+
|
|
681
|
+
**Inputs**
|
|
682
|
+
|
|
683
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
684
|
+
- Client transport options: None
|
|
685
|
+
|
|
686
|
+
**Outputs**
|
|
687
|
+
|
|
688
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" ...`
|
|
689
|
+
- OpenAPI response codes: `200`
|
|
690
|
+
|
|
691
|
+
```ts
|
|
692
|
+
import posthog from "@utdk/posthog";
|
|
693
|
+
|
|
694
|
+
type EnvironmentsFileDownloadBatchExportsListInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
695
|
+
type EnvironmentsFileDownloadBatchExportsListOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsList>>;
|
|
696
|
+
|
|
697
|
+
const result: EnvironmentsFileDownloadBatchExportsListOutput = await posthog.environmentsFileDownloadBatchExportsList();
|
|
698
|
+
|
|
699
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" ...
|
|
700
|
+
```
|
|
701
|
+
|
|
702
|
+
### `posthog.environmentsFileDownloadBatchExportsCreate`
|
|
703
|
+
|
|
704
|
+
- **HTTP**: `POST /api/environments/{environment_id}/file_download_batch_exports/`
|
|
705
|
+
- **What it does**: Create and start a batch export on demand run to download a file.
|
|
706
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_create`
|
|
707
|
+
- **Path params**: None
|
|
708
|
+
- **Query params**: None
|
|
709
|
+
- **Response codes**: `202`
|
|
710
|
+
- **Transport options**: None
|
|
711
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
712
|
+
|
|
713
|
+
**Inputs**
|
|
714
|
+
|
|
715
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
716
|
+
- Client transport options: None
|
|
717
|
+
|
|
718
|
+
**Outputs**
|
|
719
|
+
|
|
720
|
+
- Client return type: `unknown`
|
|
721
|
+
- OpenAPI response codes: `202`
|
|
722
|
+
|
|
723
|
+
```ts
|
|
724
|
+
import posthog from "@utdk/posthog";
|
|
725
|
+
|
|
726
|
+
type EnvironmentsFileDownloadBatchExportsCreateInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
727
|
+
type EnvironmentsFileDownloadBatchExportsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsCreate>>;
|
|
728
|
+
|
|
729
|
+
const result: EnvironmentsFileDownloadBatchExportsCreateOutput = await posthog.environmentsFileDownloadBatchExportsCreate();
|
|
730
|
+
|
|
731
|
+
// Result shape (from schema): unknown
|
|
732
|
+
```
|
|
733
|
+
|
|
734
|
+
### `posthog.environmentsFileDownloadBatchExportsRetrieve`
|
|
735
|
+
|
|
736
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_download_batch_exports/{id}/`
|
|
737
|
+
- **What it does**: Get a batch export on demand run.
|
|
738
|
+
|
|
739
|
+
If the underlying batch export run has completed, we return keys to the
|
|
740
|
+
generated file downloads so that users may download them by making a request
|
|
741
|
+
to /download.
|
|
742
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_retrieve`
|
|
743
|
+
- **Path params**: `id`
|
|
744
|
+
- **Query params**: None
|
|
745
|
+
- **Response codes**: `200`
|
|
746
|
+
- **Transport options**: None
|
|
747
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
748
|
+
|
|
749
|
+
**Inputs**
|
|
750
|
+
|
|
751
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
752
|
+
- Client transport options: None
|
|
753
|
+
|
|
754
|
+
**Outputs**
|
|
755
|
+
|
|
756
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
757
|
+
- OpenAPI response codes: `200`
|
|
758
|
+
|
|
759
|
+
```ts
|
|
760
|
+
import posthog from "@utdk/posthog";
|
|
761
|
+
|
|
762
|
+
type EnvironmentsFileDownloadBatchExportsRetrieveInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
763
|
+
type EnvironmentsFileDownloadBatchExportsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsRetrieve>>;
|
|
764
|
+
|
|
765
|
+
const result: EnvironmentsFileDownloadBatchExportsRetrieveOutput = await posthog.environmentsFileDownloadBatchExportsRetrieve();
|
|
766
|
+
|
|
767
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
### `posthog.environmentsFileDownloadBatchExportsCancelCreate`
|
|
771
|
+
|
|
772
|
+
- **HTTP**: `POST /api/environments/{environment_id}/file_download_batch_exports/{id}/cancel/`
|
|
773
|
+
- **What it does**: Cancel an ongoing file-download batch export.
|
|
774
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_cancel_create`
|
|
775
|
+
- **Path params**: `id`
|
|
776
|
+
- **Query params**: None
|
|
777
|
+
- **Response codes**: `200`
|
|
778
|
+
- **Transport options**: None
|
|
779
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
780
|
+
|
|
781
|
+
**Inputs**
|
|
782
|
+
|
|
783
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
784
|
+
- Client transport options: None
|
|
785
|
+
|
|
786
|
+
**Outputs**
|
|
787
|
+
|
|
788
|
+
- Client return type: `unknown`
|
|
789
|
+
- OpenAPI response codes: `200`
|
|
790
|
+
|
|
791
|
+
```ts
|
|
792
|
+
import posthog from "@utdk/posthog";
|
|
793
|
+
|
|
794
|
+
type EnvironmentsFileDownloadBatchExportsCancelCreateInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
795
|
+
type EnvironmentsFileDownloadBatchExportsCancelCreateOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsCancelCreate>>;
|
|
796
|
+
|
|
797
|
+
const result: EnvironmentsFileDownloadBatchExportsCancelCreateOutput = await posthog.environmentsFileDownloadBatchExportsCancelCreate();
|
|
798
|
+
|
|
799
|
+
// Result shape (from schema): unknown
|
|
800
|
+
```
|
|
801
|
+
|
|
802
|
+
### `posthog.environmentsFileDownloadBatchExportsDownloadRetrieve`
|
|
803
|
+
|
|
804
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_download_batch_exports/{id}/download/`
|
|
805
|
+
- **What it does**: Download a file (or a part) from this batch export run.
|
|
806
|
+
|
|
807
|
+
Users can provide a part component with an id or index, or no part component at
|
|
808
|
+
all:
|
|
809
|
+
* If part id is included: The file download matching the id is downloaded.
|
|
810
|
+
* If part index is included: The file download matching the index (as ordered
|
|
811
|
+
by key) is downloaded.
|
|
812
|
+
* If no part component is present: If there is only one file downloaded, that
|
|
813
|
+
is downloaded. Otherwise the first one as sorted by key is downloaded.
|
|
814
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_download_retrieve`
|
|
815
|
+
- **Path params**: `id`
|
|
816
|
+
- **Query params**: None
|
|
817
|
+
- **Response codes**: `200`
|
|
818
|
+
- **Transport options**: None
|
|
819
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
820
|
+
|
|
821
|
+
**Inputs**
|
|
822
|
+
|
|
823
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
824
|
+
- Client transport options: None
|
|
825
|
+
|
|
826
|
+
**Outputs**
|
|
827
|
+
|
|
828
|
+
- Client return type: `unknown`
|
|
829
|
+
- OpenAPI response codes: `200`
|
|
830
|
+
|
|
831
|
+
```ts
|
|
832
|
+
import posthog from "@utdk/posthog";
|
|
833
|
+
|
|
834
|
+
type EnvironmentsFileDownloadBatchExportsDownloadRetrieveInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsDownloadRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
835
|
+
type EnvironmentsFileDownloadBatchExportsDownloadRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsDownloadRetrieve>>;
|
|
836
|
+
|
|
837
|
+
const result: EnvironmentsFileDownloadBatchExportsDownloadRetrieveOutput = await posthog.environmentsFileDownloadBatchExportsDownloadRetrieve();
|
|
838
|
+
|
|
839
|
+
// Result shape (from schema): unknown
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
### `posthog.environmentsFileDownloadBatchExportsLogsRetrieve`
|
|
843
|
+
|
|
844
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_download_batch_exports/{id}/logs/`
|
|
845
|
+
- **OpenAPI operationId**: `environments_file_download_batch_exports_logs_retrieve`
|
|
846
|
+
- **Path params**: `id`
|
|
847
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
848
|
+
- **Response codes**: `200`
|
|
849
|
+
- **Transport options**: None
|
|
850
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
851
|
+
|
|
852
|
+
**Inputs**
|
|
853
|
+
|
|
854
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
855
|
+
- Client transport options: None
|
|
856
|
+
|
|
857
|
+
**Outputs**
|
|
858
|
+
|
|
859
|
+
- Client return type: `unknown`
|
|
860
|
+
- OpenAPI response codes: `200`
|
|
861
|
+
|
|
862
|
+
```ts
|
|
863
|
+
import posthog from "@utdk/posthog";
|
|
864
|
+
|
|
865
|
+
type EnvironmentsFileDownloadBatchExportsLogsRetrieveInput = Parameters<typeof posthog.environmentsFileDownloadBatchExportsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
866
|
+
type EnvironmentsFileDownloadBatchExportsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsFileDownloadBatchExportsLogsRetrieve>>;
|
|
867
|
+
|
|
868
|
+
const result: EnvironmentsFileDownloadBatchExportsLogsRetrieveOutput = await posthog.environmentsFileDownloadBatchExportsLogsRetrieve();
|
|
869
|
+
|
|
870
|
+
// Result shape (from schema): unknown
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
### `posthog.orgOrganizationsBatchExportsList`
|
|
874
|
+
|
|
875
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/batch_exports/`
|
|
876
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_list`
|
|
877
|
+
- **Path params**: None
|
|
878
|
+
- **Query params**: `limit`, `offset`
|
|
879
|
+
- **Response codes**: `200`
|
|
880
|
+
- **Transport options**: None
|
|
881
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
882
|
+
|
|
883
|
+
**Inputs**
|
|
884
|
+
|
|
885
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
886
|
+
- Client transport options: None
|
|
887
|
+
|
|
888
|
+
**Outputs**
|
|
889
|
+
|
|
890
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...`
|
|
891
|
+
- OpenAPI response codes: `200`
|
|
892
|
+
|
|
893
|
+
```ts
|
|
894
|
+
import posthog from "@utdk/posthog";
|
|
895
|
+
|
|
896
|
+
type OrgOrganizationsBatchExportsListInput = Parameters<typeof posthog.orgOrganizationsBatchExportsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
897
|
+
type OrgOrganizationsBatchExportsListOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsList>>;
|
|
898
|
+
|
|
899
|
+
const result: OrgOrganizationsBatchExportsListOutput = await posthog.orgOrganizationsBatchExportsList();
|
|
900
|
+
|
|
901
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...
|
|
902
|
+
```
|
|
903
|
+
|
|
904
|
+
### `posthog.orgOrganizationsBatchExportsCreate`
|
|
905
|
+
|
|
906
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/batch_exports/`
|
|
907
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_create`
|
|
908
|
+
- **Path params**: None
|
|
909
|
+
- **Query params**: None
|
|
910
|
+
- **Response codes**: `201`
|
|
911
|
+
- **Transport options**: None
|
|
912
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
913
|
+
|
|
914
|
+
**Inputs**
|
|
915
|
+
|
|
916
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
917
|
+
- Client transport options: None
|
|
918
|
+
|
|
919
|
+
**Outputs**
|
|
920
|
+
|
|
921
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
922
|
+
- OpenAPI response codes: `201`
|
|
923
|
+
|
|
924
|
+
```ts
|
|
925
|
+
import posthog from "@utdk/posthog";
|
|
926
|
+
|
|
927
|
+
type OrgOrganizationsBatchExportsCreateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
928
|
+
type OrgOrganizationsBatchExportsCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsCreate>>;
|
|
929
|
+
|
|
930
|
+
const result: OrgOrganizationsBatchExportsCreateOutput = await posthog.orgOrganizationsBatchExportsCreate();
|
|
931
|
+
|
|
932
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
933
|
+
```
|
|
934
|
+
|
|
935
|
+
### `posthog.orgOrganizationsBatchExportsDestroy`
|
|
936
|
+
|
|
937
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/batch_exports/{id}/`
|
|
938
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_destroy`
|
|
939
|
+
- **Path params**: `id`
|
|
940
|
+
- **Query params**: None
|
|
941
|
+
- **Response codes**: `204`
|
|
942
|
+
- **Transport options**: None
|
|
943
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
944
|
+
|
|
945
|
+
**Inputs**
|
|
946
|
+
|
|
947
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
948
|
+
- Client transport options: None
|
|
949
|
+
|
|
950
|
+
**Outputs**
|
|
951
|
+
|
|
952
|
+
- Client return type: `unknown`
|
|
953
|
+
- OpenAPI response codes: `204`
|
|
954
|
+
|
|
955
|
+
```ts
|
|
956
|
+
import posthog from "@utdk/posthog";
|
|
957
|
+
|
|
958
|
+
type OrgOrganizationsBatchExportsDestroyInput = Parameters<typeof posthog.orgOrganizationsBatchExportsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
959
|
+
type OrgOrganizationsBatchExportsDestroyOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsDestroy>>;
|
|
960
|
+
|
|
961
|
+
const result: OrgOrganizationsBatchExportsDestroyOutput = await posthog.orgOrganizationsBatchExportsDestroy();
|
|
962
|
+
|
|
963
|
+
// Result shape (from schema): unknown
|
|
964
|
+
```
|
|
965
|
+
|
|
966
|
+
### `posthog.orgOrganizationsBatchExportsRetrieve`
|
|
967
|
+
|
|
968
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/batch_exports/{id}/`
|
|
969
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_retrieve`
|
|
970
|
+
- **Path params**: `id`
|
|
971
|
+
- **Query params**: None
|
|
972
|
+
- **Response codes**: `200`
|
|
973
|
+
- **Transport options**: None
|
|
974
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
975
|
+
|
|
976
|
+
**Inputs**
|
|
977
|
+
|
|
978
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
979
|
+
- Client transport options: None
|
|
980
|
+
|
|
981
|
+
**Outputs**
|
|
982
|
+
|
|
983
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
984
|
+
- OpenAPI response codes: `200`
|
|
985
|
+
|
|
986
|
+
```ts
|
|
987
|
+
import posthog from "@utdk/posthog";
|
|
988
|
+
|
|
989
|
+
type OrgOrganizationsBatchExportsRetrieveInput = Parameters<typeof posthog.orgOrganizationsBatchExportsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
990
|
+
type OrgOrganizationsBatchExportsRetrieveOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsRetrieve>>;
|
|
991
|
+
|
|
992
|
+
const result: OrgOrganizationsBatchExportsRetrieveOutput = await posthog.orgOrganizationsBatchExportsRetrieve();
|
|
993
|
+
|
|
994
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
995
|
+
```
|
|
996
|
+
|
|
997
|
+
### `posthog.orgOrganizationsBatchExportsPartialUpdate`
|
|
998
|
+
|
|
999
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/batch_exports/{id}/`
|
|
1000
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_partial_update`
|
|
1001
|
+
- **Path params**: `id`
|
|
1002
|
+
- **Query params**: None
|
|
1003
|
+
- **Response codes**: `200`
|
|
1004
|
+
- **Transport options**: None
|
|
1005
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1006
|
+
|
|
1007
|
+
**Inputs**
|
|
1008
|
+
|
|
1009
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1010
|
+
- Client transport options: None
|
|
1011
|
+
|
|
1012
|
+
**Outputs**
|
|
1013
|
+
|
|
1014
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1015
|
+
- OpenAPI response codes: `200`
|
|
1016
|
+
|
|
1017
|
+
```ts
|
|
1018
|
+
import posthog from "@utdk/posthog";
|
|
1019
|
+
|
|
1020
|
+
type OrgOrganizationsBatchExportsPartialUpdateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1021
|
+
type OrgOrganizationsBatchExportsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsPartialUpdate>>;
|
|
1022
|
+
|
|
1023
|
+
const result: OrgOrganizationsBatchExportsPartialUpdateOutput = await posthog.orgOrganizationsBatchExportsPartialUpdate();
|
|
1024
|
+
|
|
1025
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1026
|
+
```
|
|
1027
|
+
|
|
1028
|
+
### `posthog.orgOrganizationsBatchExportsUpdate`
|
|
1029
|
+
|
|
1030
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/batch_exports/{id}/`
|
|
1031
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_update`
|
|
1032
|
+
- **Path params**: `id`
|
|
1033
|
+
- **Query params**: None
|
|
1034
|
+
- **Response codes**: `200`
|
|
1035
|
+
- **Transport options**: None
|
|
1036
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1037
|
+
|
|
1038
|
+
**Inputs**
|
|
1039
|
+
|
|
1040
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1041
|
+
- Client transport options: None
|
|
1042
|
+
|
|
1043
|
+
**Outputs**
|
|
1044
|
+
|
|
1045
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1046
|
+
- OpenAPI response codes: `200`
|
|
1047
|
+
|
|
1048
|
+
```ts
|
|
1049
|
+
import posthog from "@utdk/posthog";
|
|
1050
|
+
|
|
1051
|
+
type OrgOrganizationsBatchExportsUpdateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1052
|
+
type OrgOrganizationsBatchExportsUpdateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsUpdate>>;
|
|
1053
|
+
|
|
1054
|
+
const result: OrgOrganizationsBatchExportsUpdateOutput = await posthog.orgOrganizationsBatchExportsUpdate();
|
|
1055
|
+
|
|
1056
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1057
|
+
```
|
|
1058
|
+
|
|
1059
|
+
### `posthog.orgOrganizationsBatchExportsLogsRetrieve`
|
|
1060
|
+
|
|
1061
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/batch_exports/{id}/logs/`
|
|
1062
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_logs_retrieve`
|
|
1063
|
+
- **Path params**: `id`
|
|
1064
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
1065
|
+
- **Response codes**: `200`
|
|
1066
|
+
- **Transport options**: None
|
|
1067
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1068
|
+
|
|
1069
|
+
**Inputs**
|
|
1070
|
+
|
|
1071
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1072
|
+
- Client transport options: None
|
|
1073
|
+
|
|
1074
|
+
**Outputs**
|
|
1075
|
+
|
|
1076
|
+
- Client return type: `unknown`
|
|
1077
|
+
- OpenAPI response codes: `200`
|
|
1078
|
+
|
|
1079
|
+
```ts
|
|
1080
|
+
import posthog from "@utdk/posthog";
|
|
1081
|
+
|
|
1082
|
+
type OrgOrganizationsBatchExportsLogsRetrieveInput = Parameters<typeof posthog.orgOrganizationsBatchExportsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1083
|
+
type OrgOrganizationsBatchExportsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsLogsRetrieve>>;
|
|
1084
|
+
|
|
1085
|
+
const result: OrgOrganizationsBatchExportsLogsRetrieveOutput = await posthog.orgOrganizationsBatchExportsLogsRetrieve();
|
|
1086
|
+
|
|
1087
|
+
// Result shape (from schema): unknown
|
|
1088
|
+
```
|
|
1089
|
+
|
|
1090
|
+
### `posthog.orgOrganizationsBatchExportsPauseCreate`
|
|
1091
|
+
|
|
1092
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/batch_exports/{id}/pause/`
|
|
1093
|
+
- **What it does**: Pause a BatchExport.
|
|
1094
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_pause_create`
|
|
1095
|
+
- **Path params**: `id`
|
|
1096
|
+
- **Query params**: None
|
|
1097
|
+
- **Response codes**: `200`
|
|
1098
|
+
- **Transport options**: None
|
|
1099
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1100
|
+
|
|
1101
|
+
**Inputs**
|
|
1102
|
+
|
|
1103
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1104
|
+
- Client transport options: None
|
|
1105
|
+
|
|
1106
|
+
**Outputs**
|
|
1107
|
+
|
|
1108
|
+
- Client return type: `unknown`
|
|
1109
|
+
- OpenAPI response codes: `200`
|
|
1110
|
+
|
|
1111
|
+
```ts
|
|
1112
|
+
import posthog from "@utdk/posthog";
|
|
1113
|
+
|
|
1114
|
+
type OrgOrganizationsBatchExportsPauseCreateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsPauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1115
|
+
type OrgOrganizationsBatchExportsPauseCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsPauseCreate>>;
|
|
1116
|
+
|
|
1117
|
+
const result: OrgOrganizationsBatchExportsPauseCreateOutput = await posthog.orgOrganizationsBatchExportsPauseCreate();
|
|
1118
|
+
|
|
1119
|
+
// Result shape (from schema): unknown
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
### `posthog.orgOrganizationsBatchExportsRunTestStepCreate`
|
|
1123
|
+
|
|
1124
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/batch_exports/{id}/run_test_step/`
|
|
1125
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_run_test_step_create`
|
|
1126
|
+
- **Path params**: `id`
|
|
1127
|
+
- **Query params**: None
|
|
1128
|
+
- **Response codes**: `200`
|
|
1129
|
+
- **Transport options**: None
|
|
1130
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1131
|
+
|
|
1132
|
+
**Inputs**
|
|
1133
|
+
|
|
1134
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1135
|
+
- Client transport options: None
|
|
1136
|
+
|
|
1137
|
+
**Outputs**
|
|
1138
|
+
|
|
1139
|
+
- Client return type: `unknown`
|
|
1140
|
+
- OpenAPI response codes: `200`
|
|
1141
|
+
|
|
1142
|
+
```ts
|
|
1143
|
+
import posthog from "@utdk/posthog";
|
|
1144
|
+
|
|
1145
|
+
type OrgOrganizationsBatchExportsRunTestStepCreateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsRunTestStepCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1146
|
+
type OrgOrganizationsBatchExportsRunTestStepCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsRunTestStepCreate>>;
|
|
1147
|
+
|
|
1148
|
+
const result: OrgOrganizationsBatchExportsRunTestStepCreateOutput = await posthog.orgOrganizationsBatchExportsRunTestStepCreate();
|
|
1149
|
+
|
|
1150
|
+
// Result shape (from schema): unknown
|
|
1151
|
+
```
|
|
1152
|
+
|
|
1153
|
+
### `posthog.orgOrganizationsBatchExportsUnpauseCreate`
|
|
1154
|
+
|
|
1155
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/batch_exports/{id}/unpause/`
|
|
1156
|
+
- **What it does**: Unpause a BatchExport.
|
|
1157
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_unpause_create`
|
|
1158
|
+
- **Path params**: `id`
|
|
1159
|
+
- **Query params**: None
|
|
1160
|
+
- **Response codes**: `200`
|
|
1161
|
+
- **Transport options**: None
|
|
1162
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1163
|
+
|
|
1164
|
+
**Inputs**
|
|
1165
|
+
|
|
1166
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1167
|
+
- Client transport options: None
|
|
1168
|
+
|
|
1169
|
+
**Outputs**
|
|
1170
|
+
|
|
1171
|
+
- Client return type: `unknown`
|
|
1172
|
+
- OpenAPI response codes: `200`
|
|
1173
|
+
|
|
1174
|
+
```ts
|
|
1175
|
+
import posthog from "@utdk/posthog";
|
|
1176
|
+
|
|
1177
|
+
type OrgOrganizationsBatchExportsUnpauseCreateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsUnpauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1178
|
+
type OrgOrganizationsBatchExportsUnpauseCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsUnpauseCreate>>;
|
|
1179
|
+
|
|
1180
|
+
const result: OrgOrganizationsBatchExportsUnpauseCreateOutput = await posthog.orgOrganizationsBatchExportsUnpauseCreate();
|
|
1181
|
+
|
|
1182
|
+
// Result shape (from schema): unknown
|
|
1183
|
+
```
|
|
1184
|
+
|
|
1185
|
+
### `posthog.orgOrganizationsBatchExportsRunTestStepNewCreate`
|
|
1186
|
+
|
|
1187
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/batch_exports/run_test_step_new/`
|
|
1188
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_run_test_step_new_create`
|
|
1189
|
+
- **Path params**: None
|
|
1190
|
+
- **Query params**: None
|
|
1191
|
+
- **Response codes**: `200`
|
|
1192
|
+
- **Transport options**: None
|
|
1193
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1194
|
+
|
|
1195
|
+
**Inputs**
|
|
1196
|
+
|
|
1197
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1198
|
+
- Client transport options: None
|
|
1199
|
+
|
|
1200
|
+
**Outputs**
|
|
1201
|
+
|
|
1202
|
+
- Client return type: `unknown`
|
|
1203
|
+
- OpenAPI response codes: `200`
|
|
1204
|
+
|
|
1205
|
+
```ts
|
|
1206
|
+
import posthog from "@utdk/posthog";
|
|
1207
|
+
|
|
1208
|
+
type OrgOrganizationsBatchExportsRunTestStepNewCreateInput = Parameters<typeof posthog.orgOrganizationsBatchExportsRunTestStepNewCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1209
|
+
type OrgOrganizationsBatchExportsRunTestStepNewCreateOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsRunTestStepNewCreate>>;
|
|
1210
|
+
|
|
1211
|
+
const result: OrgOrganizationsBatchExportsRunTestStepNewCreateOutput = await posthog.orgOrganizationsBatchExportsRunTestStepNewCreate();
|
|
1212
|
+
|
|
1213
|
+
// Result shape (from schema): unknown
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
### `posthog.orgOrganizationsBatchExportsTestRetrieve`
|
|
1217
|
+
|
|
1218
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/batch_exports/test/`
|
|
1219
|
+
- **OpenAPI operationId**: `org_organizations_batch_exports_test_retrieve`
|
|
1220
|
+
- **Path params**: None
|
|
1221
|
+
- **Query params**: None
|
|
1222
|
+
- **Response codes**: `200`
|
|
1223
|
+
- **Transport options**: None
|
|
1224
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1225
|
+
|
|
1226
|
+
**Inputs**
|
|
1227
|
+
|
|
1228
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1229
|
+
- Client transport options: None
|
|
1230
|
+
|
|
1231
|
+
**Outputs**
|
|
1232
|
+
|
|
1233
|
+
- Client return type: `unknown`
|
|
1234
|
+
- OpenAPI response codes: `200`
|
|
1235
|
+
|
|
1236
|
+
```ts
|
|
1237
|
+
import posthog from "@utdk/posthog";
|
|
1238
|
+
|
|
1239
|
+
type OrgOrganizationsBatchExportsTestRetrieveInput = Parameters<typeof posthog.orgOrganizationsBatchExportsTestRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1240
|
+
type OrgOrganizationsBatchExportsTestRetrieveOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsBatchExportsTestRetrieve>>;
|
|
1241
|
+
|
|
1242
|
+
const result: OrgOrganizationsBatchExportsTestRetrieveOutput = await posthog.orgOrganizationsBatchExportsTestRetrieve();
|
|
1243
|
+
|
|
1244
|
+
// Result shape (from schema): unknown
|
|
1245
|
+
```
|
|
1246
|
+
|
|
1247
|
+
### `posthog.batchExportsList`
|
|
1248
|
+
|
|
1249
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/`
|
|
1250
|
+
- **OpenAPI operationId**: `batch_exports_list`
|
|
1251
|
+
- **Path params**: None
|
|
1252
|
+
- **Query params**: `limit`, `offset`
|
|
1253
|
+
- **Response codes**: `200`
|
|
1254
|
+
- **Transport options**: None
|
|
1255
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1256
|
+
|
|
1257
|
+
**Inputs**
|
|
1258
|
+
|
|
1259
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1260
|
+
- Client transport options: None
|
|
1261
|
+
|
|
1262
|
+
**Outputs**
|
|
1263
|
+
|
|
1264
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...`
|
|
1265
|
+
- OpenAPI response codes: `200`
|
|
1266
|
+
|
|
1267
|
+
```ts
|
|
1268
|
+
import posthog from "@utdk/posthog";
|
|
1269
|
+
|
|
1270
|
+
type BatchExportsListInput = Parameters<typeof posthog.batchExportsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1271
|
+
type BatchExportsListOutput = Awaited<ReturnType<typeof posthog.batchExportsList>>;
|
|
1272
|
+
|
|
1273
|
+
const result: BatchExportsListOutput = await posthog.batchExportsList();
|
|
1274
|
+
|
|
1275
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Com...
|
|
1276
|
+
```
|
|
1277
|
+
|
|
1278
|
+
### `posthog.batchExportsCreate`
|
|
1279
|
+
|
|
1280
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/`
|
|
1281
|
+
- **OpenAPI operationId**: `batch_exports_create`
|
|
1282
|
+
- **Path params**: None
|
|
1283
|
+
- **Query params**: None
|
|
1284
|
+
- **Response codes**: `201`
|
|
1285
|
+
- **Transport options**: None
|
|
1286
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1287
|
+
|
|
1288
|
+
**Inputs**
|
|
1289
|
+
|
|
1290
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1291
|
+
- Client transport options: None
|
|
1292
|
+
|
|
1293
|
+
**Outputs**
|
|
1294
|
+
|
|
1295
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1296
|
+
- OpenAPI response codes: `201`
|
|
1297
|
+
|
|
1298
|
+
```ts
|
|
1299
|
+
import posthog from "@utdk/posthog";
|
|
1300
|
+
|
|
1301
|
+
type BatchExportsCreateInput = Parameters<typeof posthog.batchExportsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1302
|
+
type BatchExportsCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsCreate>>;
|
|
1303
|
+
|
|
1304
|
+
const result: BatchExportsCreateOutput = await posthog.batchExportsCreate();
|
|
1305
|
+
|
|
1306
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1307
|
+
```
|
|
1308
|
+
|
|
1309
|
+
### `posthog.batchExportsBackfillsList`
|
|
1310
|
+
|
|
1311
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/`
|
|
1312
|
+
- **What it does**: ViewSet for BatchExportBackfill models.
|
|
1313
|
+
|
|
1314
|
+
Allows creating and reading backfills, but not updating or deleting them.
|
|
1315
|
+
- **OpenAPI operationId**: `batch_exports_backfills_list`
|
|
1316
|
+
- **Path params**: `batch_export_id`
|
|
1317
|
+
- **Query params**: `cursor`, `ordering`
|
|
1318
|
+
- **Response codes**: `200`
|
|
1319
|
+
- **Transport options**: None
|
|
1320
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1321
|
+
|
|
1322
|
+
**Inputs**
|
|
1323
|
+
|
|
1324
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1325
|
+
- Client transport options: None
|
|
1326
|
+
|
|
1327
|
+
**Outputs**
|
|
1328
|
+
|
|
1329
|
+
- Client return type: `{ next?: string | null; previous?: string | null; results: ({ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNe...`
|
|
1330
|
+
- OpenAPI response codes: `200`
|
|
1331
|
+
|
|
1332
|
+
```ts
|
|
1333
|
+
import posthog from "@utdk/posthog";
|
|
1334
|
+
|
|
1335
|
+
type BatchExportsBackfillsListInput = Parameters<typeof posthog.batchExportsBackfillsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1336
|
+
type BatchExportsBackfillsListOutput = Awaited<ReturnType<typeof posthog.batchExportsBackfillsList>>;
|
|
1337
|
+
|
|
1338
|
+
const result: BatchExportsBackfillsListOutput = await posthog.batchExportsBackfillsList();
|
|
1339
|
+
|
|
1340
|
+
// Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNe...
|
|
1341
|
+
```
|
|
1342
|
+
|
|
1343
|
+
### `posthog.batchExportsBackfillsCreate`
|
|
1344
|
+
|
|
1345
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/`
|
|
1346
|
+
- **What it does**: Create a new backfill for a BatchExport.
|
|
1347
|
+
- **OpenAPI operationId**: `batch_exports_backfills_create`
|
|
1348
|
+
- **Path params**: `batch_export_id`
|
|
1349
|
+
- **Query params**: None
|
|
1350
|
+
- **Response codes**: `201`
|
|
1351
|
+
- **Transport options**: None
|
|
1352
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1353
|
+
|
|
1354
|
+
**Inputs**
|
|
1355
|
+
|
|
1356
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1357
|
+
- Client transport options: None
|
|
1358
|
+
|
|
1359
|
+
**Outputs**
|
|
1360
|
+
|
|
1361
|
+
- Client return type: `{ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...`
|
|
1362
|
+
- OpenAPI response codes: `201`
|
|
1363
|
+
|
|
1364
|
+
```ts
|
|
1365
|
+
import posthog from "@utdk/posthog";
|
|
1366
|
+
|
|
1367
|
+
type BatchExportsBackfillsCreateInput = Parameters<typeof posthog.batchExportsBackfillsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1368
|
+
type BatchExportsBackfillsCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsBackfillsCreate>>;
|
|
1369
|
+
|
|
1370
|
+
const result: BatchExportsBackfillsCreateOutput = await posthog.batchExportsBackfillsCreate();
|
|
1371
|
+
|
|
1372
|
+
// Result shape (from schema): { id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...
|
|
1373
|
+
```
|
|
1374
|
+
|
|
1375
|
+
### `posthog.batchExportsBackfillsRetrieve`
|
|
1376
|
+
|
|
1377
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/`
|
|
1378
|
+
- **What it does**: ViewSet for BatchExportBackfill models.
|
|
1379
|
+
|
|
1380
|
+
Allows creating and reading backfills, but not updating or deleting them.
|
|
1381
|
+
- **OpenAPI operationId**: `batch_exports_backfills_retrieve`
|
|
1382
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1383
|
+
- **Query params**: None
|
|
1384
|
+
- **Response codes**: `200`
|
|
1385
|
+
- **Transport options**: None
|
|
1386
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1387
|
+
|
|
1388
|
+
**Inputs**
|
|
1389
|
+
|
|
1390
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1391
|
+
- Client transport options: None
|
|
1392
|
+
|
|
1393
|
+
**Outputs**
|
|
1394
|
+
|
|
1395
|
+
- Client return type: `{ id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...`
|
|
1396
|
+
- OpenAPI response codes: `200`
|
|
1397
|
+
|
|
1398
|
+
```ts
|
|
1399
|
+
import posthog from "@utdk/posthog";
|
|
1400
|
+
|
|
1401
|
+
type BatchExportsBackfillsRetrieveInput = Parameters<typeof posthog.batchExportsBackfillsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1402
|
+
type BatchExportsBackfillsRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsBackfillsRetrieve>>;
|
|
1403
|
+
|
|
1404
|
+
const result: BatchExportsBackfillsRetrieveOutput = await posthog.batchExportsBackfillsRetrieve();
|
|
1405
|
+
|
|
1406
|
+
// Result shape (from schema): { id: string; progress: { [key: string]: unknown } | null; start_at?: string | null; end_at?: string | null; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "Terminated" | "TimedOut...
|
|
1407
|
+
```
|
|
1408
|
+
|
|
1409
|
+
### `posthog.batchExportsBackfillsCancelCreate`
|
|
1410
|
+
|
|
1411
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/`
|
|
1412
|
+
- **What it does**: Cancel a batch export backfill.
|
|
1413
|
+
- **OpenAPI operationId**: `batch_exports_backfills_cancel_create`
|
|
1414
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1415
|
+
- **Query params**: None
|
|
1416
|
+
- **Response codes**: `200`
|
|
1417
|
+
- **Transport options**: None
|
|
1418
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1419
|
+
|
|
1420
|
+
**Inputs**
|
|
1421
|
+
|
|
1422
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1423
|
+
- Client transport options: None
|
|
1424
|
+
|
|
1425
|
+
**Outputs**
|
|
1426
|
+
|
|
1427
|
+
- Client return type: `unknown`
|
|
1428
|
+
- OpenAPI response codes: `200`
|
|
1429
|
+
|
|
1430
|
+
```ts
|
|
1431
|
+
import posthog from "@utdk/posthog";
|
|
1432
|
+
|
|
1433
|
+
type BatchExportsBackfillsCancelCreateInput = Parameters<typeof posthog.batchExportsBackfillsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1434
|
+
type BatchExportsBackfillsCancelCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsBackfillsCancelCreate>>;
|
|
1435
|
+
|
|
1436
|
+
const result: BatchExportsBackfillsCancelCreateOutput = await posthog.batchExportsBackfillsCancelCreate();
|
|
1437
|
+
|
|
1438
|
+
// Result shape (from schema): unknown
|
|
1439
|
+
```
|
|
1440
|
+
|
|
1441
|
+
### `posthog.batchExportsRunsList`
|
|
1442
|
+
|
|
1443
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/`
|
|
1444
|
+
- **OpenAPI operationId**: `batch_exports_runs_list`
|
|
1445
|
+
- **Path params**: `batch_export_id`
|
|
1446
|
+
- **Query params**: `cursor`, `ordering`
|
|
1447
|
+
- **Response codes**: `200`
|
|
1448
|
+
- **Transport options**: None
|
|
1449
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1450
|
+
|
|
1451
|
+
**Inputs**
|
|
1452
|
+
|
|
1453
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1454
|
+
- Client transport options: None
|
|
1455
|
+
|
|
1456
|
+
**Outputs**
|
|
1457
|
+
|
|
1458
|
+
- Client return type: `{ next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "...`
|
|
1459
|
+
- OpenAPI response codes: `200`
|
|
1460
|
+
|
|
1461
|
+
```ts
|
|
1462
|
+
import posthog from "@utdk/posthog";
|
|
1463
|
+
|
|
1464
|
+
type BatchExportsRunsListInput = Parameters<typeof posthog.batchExportsRunsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1465
|
+
type BatchExportsRunsListOutput = Awaited<ReturnType<typeof posthog.batchExportsRunsList>>;
|
|
1466
|
+
|
|
1467
|
+
const result: BatchExportsRunsListOutput = await posthog.batchExportsRunsList();
|
|
1468
|
+
|
|
1469
|
+
// Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "...
|
|
1470
|
+
```
|
|
1471
|
+
|
|
1472
|
+
### `posthog.batchExportsRunsRetrieve`
|
|
1473
|
+
|
|
1474
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/`
|
|
1475
|
+
- **OpenAPI operationId**: `batch_exports_runs_retrieve`
|
|
1476
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1477
|
+
- **Query params**: None
|
|
1478
|
+
- **Response codes**: `200`
|
|
1479
|
+
- **Transport options**: None
|
|
1480
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1481
|
+
|
|
1482
|
+
**Inputs**
|
|
1483
|
+
|
|
1484
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1485
|
+
- Client transport options: None
|
|
1486
|
+
|
|
1487
|
+
**Outputs**
|
|
1488
|
+
|
|
1489
|
+
- Client return type: `{ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "Starting"; records_completed?: number | null; records_failed...`
|
|
1490
|
+
- OpenAPI response codes: `200`
|
|
1491
|
+
|
|
1492
|
+
```ts
|
|
1493
|
+
import posthog from "@utdk/posthog";
|
|
1494
|
+
|
|
1495
|
+
type BatchExportsRunsRetrieveInput = Parameters<typeof posthog.batchExportsRunsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1496
|
+
type BatchExportsRunsRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsRunsRetrieve>>;
|
|
1497
|
+
|
|
1498
|
+
const result: BatchExportsRunsRetrieveOutput = await posthog.batchExportsRunsRetrieve();
|
|
1499
|
+
|
|
1500
|
+
// Result shape (from schema): { id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" | "Running" | "Starting"; records_completed?: number | null; records_failed...
|
|
1501
|
+
```
|
|
1502
|
+
|
|
1503
|
+
### `posthog.batchExportsRunsCancelCreate`
|
|
1504
|
+
|
|
1505
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/`
|
|
1506
|
+
- **What it does**: Cancel a batch export run.
|
|
1507
|
+
- **OpenAPI operationId**: `batch_exports_runs_cancel_create`
|
|
1508
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1509
|
+
- **Query params**: None
|
|
1510
|
+
- **Response codes**: `200`
|
|
1511
|
+
- **Transport options**: None
|
|
1512
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1513
|
+
|
|
1514
|
+
**Inputs**
|
|
1515
|
+
|
|
1516
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1517
|
+
- Client transport options: None
|
|
1518
|
+
|
|
1519
|
+
**Outputs**
|
|
1520
|
+
|
|
1521
|
+
- Client return type: `unknown`
|
|
1522
|
+
- OpenAPI response codes: `200`
|
|
1523
|
+
|
|
1524
|
+
```ts
|
|
1525
|
+
import posthog from "@utdk/posthog";
|
|
1526
|
+
|
|
1527
|
+
type BatchExportsRunsCancelCreateInput = Parameters<typeof posthog.batchExportsRunsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1528
|
+
type BatchExportsRunsCancelCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsRunsCancelCreate>>;
|
|
1529
|
+
|
|
1530
|
+
const result: BatchExportsRunsCancelCreateOutput = await posthog.batchExportsRunsCancelCreate();
|
|
1531
|
+
|
|
1532
|
+
// Result shape (from schema): unknown
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
### `posthog.batchExportsRunsLogsRetrieve`
|
|
1536
|
+
|
|
1537
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/logs/`
|
|
1538
|
+
- **OpenAPI operationId**: `batch_exports_runs_logs_retrieve`
|
|
1539
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1540
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
1541
|
+
- **Response codes**: `200`
|
|
1542
|
+
- **Transport options**: None
|
|
1543
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1544
|
+
|
|
1545
|
+
**Inputs**
|
|
1546
|
+
|
|
1547
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1548
|
+
- Client transport options: None
|
|
1549
|
+
|
|
1550
|
+
**Outputs**
|
|
1551
|
+
|
|
1552
|
+
- Client return type: `unknown`
|
|
1553
|
+
- OpenAPI response codes: `200`
|
|
1554
|
+
|
|
1555
|
+
```ts
|
|
1556
|
+
import posthog from "@utdk/posthog";
|
|
1557
|
+
|
|
1558
|
+
type BatchExportsRunsLogsRetrieveInput = Parameters<typeof posthog.batchExportsRunsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1559
|
+
type BatchExportsRunsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsRunsLogsRetrieve>>;
|
|
1560
|
+
|
|
1561
|
+
const result: BatchExportsRunsLogsRetrieveOutput = await posthog.batchExportsRunsLogsRetrieve();
|
|
1562
|
+
|
|
1563
|
+
// Result shape (from schema): unknown
|
|
1564
|
+
```
|
|
1565
|
+
|
|
1566
|
+
### `posthog.batchExportsRunsRetryCreate`
|
|
1567
|
+
|
|
1568
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/retry/`
|
|
1569
|
+
- **What it does**: Retry a batch export run.
|
|
1570
|
+
|
|
1571
|
+
We use the same underlying mechanism as when backfilling a batch export, as retrying
|
|
1572
|
+
a run is the same as backfilling one run.
|
|
1573
|
+
- **OpenAPI operationId**: `batch_exports_runs_retry_create`
|
|
1574
|
+
- **Path params**: `batch_export_id`, `id`
|
|
1575
|
+
- **Query params**: None
|
|
1576
|
+
- **Response codes**: `200`
|
|
1577
|
+
- **Transport options**: None
|
|
1578
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1579
|
+
|
|
1580
|
+
**Inputs**
|
|
1581
|
+
|
|
1582
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1583
|
+
- Client transport options: None
|
|
1584
|
+
|
|
1585
|
+
**Outputs**
|
|
1586
|
+
|
|
1587
|
+
- Client return type: `unknown`
|
|
1588
|
+
- OpenAPI response codes: `200`
|
|
1589
|
+
|
|
1590
|
+
```ts
|
|
1591
|
+
import posthog from "@utdk/posthog";
|
|
1592
|
+
|
|
1593
|
+
type BatchExportsRunsRetryCreateInput = Parameters<typeof posthog.batchExportsRunsRetryCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1594
|
+
type BatchExportsRunsRetryCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsRunsRetryCreate>>;
|
|
1595
|
+
|
|
1596
|
+
const result: BatchExportsRunsRetryCreateOutput = await posthog.batchExportsRunsRetryCreate();
|
|
1597
|
+
|
|
1598
|
+
// Result shape (from schema): unknown
|
|
1599
|
+
```
|
|
1600
|
+
|
|
1601
|
+
### `posthog.batchExportsDestroy`
|
|
1602
|
+
|
|
1603
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/batch_exports/{id}/`
|
|
1604
|
+
- **OpenAPI operationId**: `batch_exports_destroy`
|
|
1605
|
+
- **Path params**: `id`
|
|
1606
|
+
- **Query params**: None
|
|
1607
|
+
- **Response codes**: `204`
|
|
1608
|
+
- **Transport options**: None
|
|
1609
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1610
|
+
|
|
1611
|
+
**Inputs**
|
|
1612
|
+
|
|
1613
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1614
|
+
- Client transport options: None
|
|
1615
|
+
|
|
1616
|
+
**Outputs**
|
|
1617
|
+
|
|
1618
|
+
- Client return type: `unknown`
|
|
1619
|
+
- OpenAPI response codes: `204`
|
|
1620
|
+
|
|
1621
|
+
```ts
|
|
1622
|
+
import posthog from "@utdk/posthog";
|
|
1623
|
+
|
|
1624
|
+
type BatchExportsDestroyInput = Parameters<typeof posthog.batchExportsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1625
|
+
type BatchExportsDestroyOutput = Awaited<ReturnType<typeof posthog.batchExportsDestroy>>;
|
|
1626
|
+
|
|
1627
|
+
const result: BatchExportsDestroyOutput = await posthog.batchExportsDestroy();
|
|
1628
|
+
|
|
1629
|
+
// Result shape (from schema): unknown
|
|
1630
|
+
```
|
|
1631
|
+
|
|
1632
|
+
### `posthog.batchExportsRetrieve`
|
|
1633
|
+
|
|
1634
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{id}/`
|
|
1635
|
+
- **OpenAPI operationId**: `batch_exports_retrieve`
|
|
1636
|
+
- **Path params**: `id`
|
|
1637
|
+
- **Query params**: None
|
|
1638
|
+
- **Response codes**: `200`
|
|
1639
|
+
- **Transport options**: None
|
|
1640
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1641
|
+
|
|
1642
|
+
**Inputs**
|
|
1643
|
+
|
|
1644
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1645
|
+
- Client transport options: None
|
|
1646
|
+
|
|
1647
|
+
**Outputs**
|
|
1648
|
+
|
|
1649
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1650
|
+
- OpenAPI response codes: `200`
|
|
1651
|
+
|
|
1652
|
+
```ts
|
|
1653
|
+
import posthog from "@utdk/posthog";
|
|
1654
|
+
|
|
1655
|
+
type BatchExportsRetrieveInput = Parameters<typeof posthog.batchExportsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1656
|
+
type BatchExportsRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsRetrieve>>;
|
|
1657
|
+
|
|
1658
|
+
const result: BatchExportsRetrieveOutput = await posthog.batchExportsRetrieve();
|
|
1659
|
+
|
|
1660
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1661
|
+
```
|
|
1662
|
+
|
|
1663
|
+
### `posthog.batchExportsPartialUpdate`
|
|
1664
|
+
|
|
1665
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/batch_exports/{id}/`
|
|
1666
|
+
- **OpenAPI operationId**: `batch_exports_partial_update`
|
|
1667
|
+
- **Path params**: `id`
|
|
1668
|
+
- **Query params**: None
|
|
1669
|
+
- **Response codes**: `200`
|
|
1670
|
+
- **Transport options**: None
|
|
1671
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1672
|
+
|
|
1673
|
+
**Inputs**
|
|
1674
|
+
|
|
1675
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1676
|
+
- Client transport options: None
|
|
1677
|
+
|
|
1678
|
+
**Outputs**
|
|
1679
|
+
|
|
1680
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1681
|
+
- OpenAPI response codes: `200`
|
|
1682
|
+
|
|
1683
|
+
```ts
|
|
1684
|
+
import posthog from "@utdk/posthog";
|
|
1685
|
+
|
|
1686
|
+
type BatchExportsPartialUpdateInput = Parameters<typeof posthog.batchExportsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1687
|
+
type BatchExportsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.batchExportsPartialUpdate>>;
|
|
1688
|
+
|
|
1689
|
+
const result: BatchExportsPartialUpdateOutput = await posthog.batchExportsPartialUpdate();
|
|
1690
|
+
|
|
1691
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1692
|
+
```
|
|
1693
|
+
|
|
1694
|
+
### `posthog.batchExportsUpdate`
|
|
1695
|
+
|
|
1696
|
+
- **HTTP**: `PUT /api/projects/{project_id}/batch_exports/{id}/`
|
|
1697
|
+
- **OpenAPI operationId**: `batch_exports_update`
|
|
1698
|
+
- **Path params**: `id`
|
|
1699
|
+
- **Query params**: None
|
|
1700
|
+
- **Response codes**: `200`
|
|
1701
|
+
- **Transport options**: None
|
|
1702
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1703
|
+
|
|
1704
|
+
**Inputs**
|
|
1705
|
+
|
|
1706
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1707
|
+
- Client transport options: None
|
|
1708
|
+
|
|
1709
|
+
**Outputs**
|
|
1710
|
+
|
|
1711
|
+
- Client return type: `{ id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...`
|
|
1712
|
+
- OpenAPI response codes: `200`
|
|
1713
|
+
|
|
1714
|
+
```ts
|
|
1715
|
+
import posthog from "@utdk/posthog";
|
|
1716
|
+
|
|
1717
|
+
type BatchExportsUpdateInput = Parameters<typeof posthog.batchExportsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1718
|
+
type BatchExportsUpdateOutput = Awaited<ReturnType<typeof posthog.batchExportsUpdate>>;
|
|
1719
|
+
|
|
1720
|
+
const result: BatchExportsUpdateOutput = await posthog.batchExportsUpdate();
|
|
1721
|
+
|
|
1722
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; model?: "events" | "persons" | "sessions" | "" | null; destination: { type: "S3" | "AwsS3" | "S3Compatible" | "Snowflake" | "Postgres" | "Redshift" | "BigQuery" | "Databricks...
|
|
1723
|
+
```
|
|
1724
|
+
|
|
1725
|
+
### `posthog.batchExportsLogsRetrieve`
|
|
1726
|
+
|
|
1727
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/{id}/logs/`
|
|
1728
|
+
- **OpenAPI operationId**: `batch_exports_logs_retrieve`
|
|
1729
|
+
- **Path params**: `id`
|
|
1730
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
1731
|
+
- **Response codes**: `200`
|
|
1732
|
+
- **Transport options**: None
|
|
1733
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1734
|
+
|
|
1735
|
+
**Inputs**
|
|
1736
|
+
|
|
1737
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1738
|
+
- Client transport options: None
|
|
1739
|
+
|
|
1740
|
+
**Outputs**
|
|
1741
|
+
|
|
1742
|
+
- Client return type: `unknown`
|
|
1743
|
+
- OpenAPI response codes: `200`
|
|
1744
|
+
|
|
1745
|
+
```ts
|
|
1746
|
+
import posthog from "@utdk/posthog";
|
|
1747
|
+
|
|
1748
|
+
type BatchExportsLogsRetrieveInput = Parameters<typeof posthog.batchExportsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1749
|
+
type BatchExportsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsLogsRetrieve>>;
|
|
1750
|
+
|
|
1751
|
+
const result: BatchExportsLogsRetrieveOutput = await posthog.batchExportsLogsRetrieve();
|
|
1752
|
+
|
|
1753
|
+
// Result shape (from schema): unknown
|
|
1754
|
+
```
|
|
1755
|
+
|
|
1756
|
+
### `posthog.batchExportsPauseCreate`
|
|
1757
|
+
|
|
1758
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{id}/pause/`
|
|
1759
|
+
- **What it does**: Pause a BatchExport.
|
|
1760
|
+
- **OpenAPI operationId**: `batch_exports_pause_create`
|
|
1761
|
+
- **Path params**: `id`
|
|
1762
|
+
- **Query params**: None
|
|
1763
|
+
- **Response codes**: `200`
|
|
1764
|
+
- **Transport options**: None
|
|
1765
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1766
|
+
|
|
1767
|
+
**Inputs**
|
|
1768
|
+
|
|
1769
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1770
|
+
- Client transport options: None
|
|
1771
|
+
|
|
1772
|
+
**Outputs**
|
|
1773
|
+
|
|
1774
|
+
- Client return type: `unknown`
|
|
1775
|
+
- OpenAPI response codes: `200`
|
|
1776
|
+
|
|
1777
|
+
```ts
|
|
1778
|
+
import posthog from "@utdk/posthog";
|
|
1779
|
+
|
|
1780
|
+
type BatchExportsPauseCreateInput = Parameters<typeof posthog.batchExportsPauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1781
|
+
type BatchExportsPauseCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsPauseCreate>>;
|
|
1782
|
+
|
|
1783
|
+
const result: BatchExportsPauseCreateOutput = await posthog.batchExportsPauseCreate();
|
|
1784
|
+
|
|
1785
|
+
// Result shape (from schema): unknown
|
|
1786
|
+
```
|
|
1787
|
+
|
|
1788
|
+
### `posthog.batchExportsRunTestStepCreate`
|
|
1789
|
+
|
|
1790
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{id}/run_test_step/`
|
|
1791
|
+
- **OpenAPI operationId**: `batch_exports_run_test_step_create`
|
|
1792
|
+
- **Path params**: `id`
|
|
1793
|
+
- **Query params**: None
|
|
1794
|
+
- **Response codes**: `200`
|
|
1795
|
+
- **Transport options**: None
|
|
1796
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1797
|
+
|
|
1798
|
+
**Inputs**
|
|
1799
|
+
|
|
1800
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1801
|
+
- Client transport options: None
|
|
1802
|
+
|
|
1803
|
+
**Outputs**
|
|
1804
|
+
|
|
1805
|
+
- Client return type: `unknown`
|
|
1806
|
+
- OpenAPI response codes: `200`
|
|
1807
|
+
|
|
1808
|
+
```ts
|
|
1809
|
+
import posthog from "@utdk/posthog";
|
|
1810
|
+
|
|
1811
|
+
type BatchExportsRunTestStepCreateInput = Parameters<typeof posthog.batchExportsRunTestStepCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1812
|
+
type BatchExportsRunTestStepCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsRunTestStepCreate>>;
|
|
1813
|
+
|
|
1814
|
+
const result: BatchExportsRunTestStepCreateOutput = await posthog.batchExportsRunTestStepCreate();
|
|
1815
|
+
|
|
1816
|
+
// Result shape (from schema): unknown
|
|
1817
|
+
```
|
|
1818
|
+
|
|
1819
|
+
### `posthog.batchExportsUnpauseCreate`
|
|
1820
|
+
|
|
1821
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/{id}/unpause/`
|
|
1822
|
+
- **What it does**: Unpause a BatchExport.
|
|
1823
|
+
- **OpenAPI operationId**: `batch_exports_unpause_create`
|
|
1824
|
+
- **Path params**: `id`
|
|
1825
|
+
- **Query params**: None
|
|
1826
|
+
- **Response codes**: `200`
|
|
1827
|
+
- **Transport options**: None
|
|
1828
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1829
|
+
|
|
1830
|
+
**Inputs**
|
|
1831
|
+
|
|
1832
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1833
|
+
- Client transport options: None
|
|
1834
|
+
|
|
1835
|
+
**Outputs**
|
|
1836
|
+
|
|
1837
|
+
- Client return type: `unknown`
|
|
1838
|
+
- OpenAPI response codes: `200`
|
|
1839
|
+
|
|
1840
|
+
```ts
|
|
1841
|
+
import posthog from "@utdk/posthog";
|
|
1842
|
+
|
|
1843
|
+
type BatchExportsUnpauseCreateInput = Parameters<typeof posthog.batchExportsUnpauseCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1844
|
+
type BatchExportsUnpauseCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsUnpauseCreate>>;
|
|
1845
|
+
|
|
1846
|
+
const result: BatchExportsUnpauseCreateOutput = await posthog.batchExportsUnpauseCreate();
|
|
1847
|
+
|
|
1848
|
+
// Result shape (from schema): unknown
|
|
1849
|
+
```
|
|
1850
|
+
|
|
1851
|
+
### `posthog.batchExportsRunTestStepNewCreate`
|
|
1852
|
+
|
|
1853
|
+
- **HTTP**: `POST /api/projects/{project_id}/batch_exports/run_test_step_new/`
|
|
1854
|
+
- **OpenAPI operationId**: `batch_exports_run_test_step_new_create`
|
|
1855
|
+
- **Path params**: None
|
|
1856
|
+
- **Query params**: None
|
|
1857
|
+
- **Response codes**: `200`
|
|
1858
|
+
- **Transport options**: None
|
|
1859
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1860
|
+
|
|
1861
|
+
**Inputs**
|
|
1862
|
+
|
|
1863
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1864
|
+
- Client transport options: None
|
|
1865
|
+
|
|
1866
|
+
**Outputs**
|
|
1867
|
+
|
|
1868
|
+
- Client return type: `unknown`
|
|
1869
|
+
- OpenAPI response codes: `200`
|
|
1870
|
+
|
|
1871
|
+
```ts
|
|
1872
|
+
import posthog from "@utdk/posthog";
|
|
1873
|
+
|
|
1874
|
+
type BatchExportsRunTestStepNewCreateInput = Parameters<typeof posthog.batchExportsRunTestStepNewCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1875
|
+
type BatchExportsRunTestStepNewCreateOutput = Awaited<ReturnType<typeof posthog.batchExportsRunTestStepNewCreate>>;
|
|
1876
|
+
|
|
1877
|
+
const result: BatchExportsRunTestStepNewCreateOutput = await posthog.batchExportsRunTestStepNewCreate();
|
|
1878
|
+
|
|
1879
|
+
// Result shape (from schema): unknown
|
|
1880
|
+
```
|
|
1881
|
+
|
|
1882
|
+
### `posthog.batchExportsTestRetrieve`
|
|
1883
|
+
|
|
1884
|
+
- **HTTP**: `GET /api/projects/{project_id}/batch_exports/test/`
|
|
1885
|
+
- **OpenAPI operationId**: `batch_exports_test_retrieve`
|
|
1886
|
+
- **Path params**: None
|
|
1887
|
+
- **Query params**: None
|
|
1888
|
+
- **Response codes**: `200`
|
|
1889
|
+
- **Transport options**: None
|
|
1890
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1891
|
+
|
|
1892
|
+
**Inputs**
|
|
1893
|
+
|
|
1894
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1895
|
+
- Client transport options: None
|
|
1896
|
+
|
|
1897
|
+
**Outputs**
|
|
1898
|
+
|
|
1899
|
+
- Client return type: `unknown`
|
|
1900
|
+
- OpenAPI response codes: `200`
|
|
1901
|
+
|
|
1902
|
+
```ts
|
|
1903
|
+
import posthog from "@utdk/posthog";
|
|
1904
|
+
|
|
1905
|
+
type BatchExportsTestRetrieveInput = Parameters<typeof posthog.batchExportsTestRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1906
|
+
type BatchExportsTestRetrieveOutput = Awaited<ReturnType<typeof posthog.batchExportsTestRetrieve>>;
|
|
1907
|
+
|
|
1908
|
+
const result: BatchExportsTestRetrieveOutput = await posthog.batchExportsTestRetrieve();
|
|
1909
|
+
|
|
1910
|
+
// Result shape (from schema): unknown
|
|
1911
|
+
```
|
|
1912
|
+
|
|
1913
|
+
### `posthog.fileDownloadBatchExportsList`
|
|
1914
|
+
|
|
1915
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_download_batch_exports/`
|
|
1916
|
+
- **OpenAPI operationId**: `file_download_batch_exports_list`
|
|
1917
|
+
- **Path params**: None
|
|
1918
|
+
- **Query params**: `limit`, `offset`
|
|
1919
|
+
- **Response codes**: `200`
|
|
1920
|
+
- **Transport options**: None
|
|
1921
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1922
|
+
|
|
1923
|
+
**Inputs**
|
|
1924
|
+
|
|
1925
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1926
|
+
- Client transport options: None
|
|
1927
|
+
|
|
1928
|
+
**Outputs**
|
|
1929
|
+
|
|
1930
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" ...`
|
|
1931
|
+
- OpenAPI response codes: `200`
|
|
1932
|
+
|
|
1933
|
+
```ts
|
|
1934
|
+
import posthog from "@utdk/posthog";
|
|
1935
|
+
|
|
1936
|
+
type FileDownloadBatchExportsListInput = Parameters<typeof posthog.fileDownloadBatchExportsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1937
|
+
type FileDownloadBatchExportsListOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsList>>;
|
|
1938
|
+
|
|
1939
|
+
const result: FileDownloadBatchExportsListOutput = await posthog.fileDownloadBatchExportsList();
|
|
1940
|
+
|
|
1941
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "Cancelled" | "Completed" | "ContinuedAsNew" | "Failed" | "FailedRetryable" | "FailedBilling" | "Terminated" | "TimedOut" ...
|
|
1942
|
+
```
|
|
1943
|
+
|
|
1944
|
+
### `posthog.fileDownloadBatchExportsCreate`
|
|
1945
|
+
|
|
1946
|
+
- **HTTP**: `POST /api/projects/{project_id}/file_download_batch_exports/`
|
|
1947
|
+
- **What it does**: Create and start a batch export on demand run to download a file.
|
|
1948
|
+
- **OpenAPI operationId**: `file_download_batch_exports_create`
|
|
1949
|
+
- **Path params**: None
|
|
1950
|
+
- **Query params**: None
|
|
1951
|
+
- **Response codes**: `202`
|
|
1952
|
+
- **Transport options**: None
|
|
1953
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1954
|
+
|
|
1955
|
+
**Inputs**
|
|
1956
|
+
|
|
1957
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1958
|
+
- Client transport options: None
|
|
1959
|
+
|
|
1960
|
+
**Outputs**
|
|
1961
|
+
|
|
1962
|
+
- Client return type: `unknown`
|
|
1963
|
+
- OpenAPI response codes: `202`
|
|
1964
|
+
|
|
1965
|
+
```ts
|
|
1966
|
+
import posthog from "@utdk/posthog";
|
|
1967
|
+
|
|
1968
|
+
type FileDownloadBatchExportsCreateInput = Parameters<typeof posthog.fileDownloadBatchExportsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1969
|
+
type FileDownloadBatchExportsCreateOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsCreate>>;
|
|
1970
|
+
|
|
1971
|
+
const result: FileDownloadBatchExportsCreateOutput = await posthog.fileDownloadBatchExportsCreate();
|
|
1972
|
+
|
|
1973
|
+
// Result shape (from schema): unknown
|
|
1974
|
+
```
|
|
1975
|
+
|
|
1976
|
+
### `posthog.fileDownloadBatchExportsRetrieve`
|
|
1977
|
+
|
|
1978
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_download_batch_exports/{id}/`
|
|
1979
|
+
- **What it does**: Get a batch export on demand run.
|
|
1980
|
+
|
|
1981
|
+
If the underlying batch export run has completed, we return keys to the
|
|
1982
|
+
generated file downloads so that users may download them by making a request
|
|
1983
|
+
to /download.
|
|
1984
|
+
- **OpenAPI operationId**: `file_download_batch_exports_retrieve`
|
|
1985
|
+
- **Path params**: `id`
|
|
1986
|
+
- **Query params**: None
|
|
1987
|
+
- **Response codes**: `200`
|
|
1988
|
+
- **Transport options**: None
|
|
1989
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1990
|
+
|
|
1991
|
+
**Inputs**
|
|
1992
|
+
|
|
1993
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1994
|
+
- Client transport options: None
|
|
1995
|
+
|
|
1996
|
+
**Outputs**
|
|
1997
|
+
|
|
1998
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
1999
|
+
- OpenAPI response codes: `200`
|
|
2000
|
+
|
|
2001
|
+
```ts
|
|
2002
|
+
import posthog from "@utdk/posthog";
|
|
2003
|
+
|
|
2004
|
+
type FileDownloadBatchExportsRetrieveInput = Parameters<typeof posthog.fileDownloadBatchExportsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2005
|
+
type FileDownloadBatchExportsRetrieveOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsRetrieve>>;
|
|
2006
|
+
|
|
2007
|
+
const result: FileDownloadBatchExportsRetrieveOutput = await posthog.fileDownloadBatchExportsRetrieve();
|
|
2008
|
+
|
|
2009
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
2010
|
+
```
|
|
2011
|
+
|
|
2012
|
+
### `posthog.fileDownloadBatchExportsCancelCreate`
|
|
2013
|
+
|
|
2014
|
+
- **HTTP**: `POST /api/projects/{project_id}/file_download_batch_exports/{id}/cancel/`
|
|
2015
|
+
- **What it does**: Cancel an ongoing file-download batch export.
|
|
2016
|
+
- **OpenAPI operationId**: `file_download_batch_exports_cancel_create`
|
|
2017
|
+
- **Path params**: `id`
|
|
2018
|
+
- **Query params**: None
|
|
2019
|
+
- **Response codes**: `200`
|
|
2020
|
+
- **Transport options**: None
|
|
2021
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2022
|
+
|
|
2023
|
+
**Inputs**
|
|
2024
|
+
|
|
2025
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2026
|
+
- Client transport options: None
|
|
2027
|
+
|
|
2028
|
+
**Outputs**
|
|
2029
|
+
|
|
2030
|
+
- Client return type: `unknown`
|
|
2031
|
+
- OpenAPI response codes: `200`
|
|
2032
|
+
|
|
2033
|
+
```ts
|
|
2034
|
+
import posthog from "@utdk/posthog";
|
|
2035
|
+
|
|
2036
|
+
type FileDownloadBatchExportsCancelCreateInput = Parameters<typeof posthog.fileDownloadBatchExportsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2037
|
+
type FileDownloadBatchExportsCancelCreateOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsCancelCreate>>;
|
|
2038
|
+
|
|
2039
|
+
const result: FileDownloadBatchExportsCancelCreateOutput = await posthog.fileDownloadBatchExportsCancelCreate();
|
|
2040
|
+
|
|
2041
|
+
// Result shape (from schema): unknown
|
|
2042
|
+
```
|
|
2043
|
+
|
|
2044
|
+
### `posthog.fileDownloadBatchExportsDownloadRetrieve`
|
|
2045
|
+
|
|
2046
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_download_batch_exports/{id}/download/`
|
|
2047
|
+
- **What it does**: Download a file (or a part) from this batch export run.
|
|
2048
|
+
|
|
2049
|
+
Users can provide a part component with an id or index, or no part component at
|
|
2050
|
+
all:
|
|
2051
|
+
* If part id is included: The file download matching the id is downloaded.
|
|
2052
|
+
* If part index is included: The file download matching the index (as ordered
|
|
2053
|
+
by key) is downloaded.
|
|
2054
|
+
* If no part component is present: If there is only one file downloaded, that
|
|
2055
|
+
is downloaded. Otherwise the first one as sorted by key is downloaded.
|
|
2056
|
+
- **OpenAPI operationId**: `file_download_batch_exports_download_retrieve`
|
|
2057
|
+
- **Path params**: `id`
|
|
2058
|
+
- **Query params**: None
|
|
2059
|
+
- **Response codes**: `200`
|
|
2060
|
+
- **Transport options**: None
|
|
2061
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2062
|
+
|
|
2063
|
+
**Inputs**
|
|
2064
|
+
|
|
2065
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2066
|
+
- Client transport options: None
|
|
2067
|
+
|
|
2068
|
+
**Outputs**
|
|
2069
|
+
|
|
2070
|
+
- Client return type: `unknown`
|
|
2071
|
+
- OpenAPI response codes: `200`
|
|
2072
|
+
|
|
2073
|
+
```ts
|
|
2074
|
+
import posthog from "@utdk/posthog";
|
|
2075
|
+
|
|
2076
|
+
type FileDownloadBatchExportsDownloadRetrieveInput = Parameters<typeof posthog.fileDownloadBatchExportsDownloadRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2077
|
+
type FileDownloadBatchExportsDownloadRetrieveOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsDownloadRetrieve>>;
|
|
2078
|
+
|
|
2079
|
+
const result: FileDownloadBatchExportsDownloadRetrieveOutput = await posthog.fileDownloadBatchExportsDownloadRetrieve();
|
|
2080
|
+
|
|
2081
|
+
// Result shape (from schema): unknown
|
|
2082
|
+
```
|
|
2083
|
+
|
|
2084
|
+
### `posthog.fileDownloadBatchExportsLogsRetrieve`
|
|
2085
|
+
|
|
2086
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_download_batch_exports/{id}/logs/`
|
|
2087
|
+
- **OpenAPI operationId**: `file_download_batch_exports_logs_retrieve`
|
|
2088
|
+
- **Path params**: `id`
|
|
2089
|
+
- **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
|
|
2090
|
+
- **Response codes**: `200`
|
|
2091
|
+
- **Transport options**: None
|
|
2092
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2093
|
+
|
|
2094
|
+
**Inputs**
|
|
2095
|
+
|
|
2096
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2097
|
+
- Client transport options: None
|
|
2098
|
+
|
|
2099
|
+
**Outputs**
|
|
2100
|
+
|
|
2101
|
+
- Client return type: `unknown`
|
|
2102
|
+
- OpenAPI response codes: `200`
|
|
2103
|
+
|
|
2104
|
+
```ts
|
|
2105
|
+
import posthog from "@utdk/posthog";
|
|
2106
|
+
|
|
2107
|
+
type FileDownloadBatchExportsLogsRetrieveInput = Parameters<typeof posthog.fileDownloadBatchExportsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2108
|
+
type FileDownloadBatchExportsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.fileDownloadBatchExportsLogsRetrieve>>;
|
|
2109
|
+
|
|
2110
|
+
const result: FileDownloadBatchExportsLogsRetrieveOutput = await posthog.fileDownloadBatchExportsLogsRetrieve();
|
|
2111
|
+
|
|
2112
|
+
// Result shape (from schema): unknown
|
|
2113
|
+
```
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
<!-- prompt-hash:
|
|
2117
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
2118
|
+
-->
|