@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
package/docs/replay.md
ADDED
|
@@ -0,0 +1,1020 @@
|
|
|
1
|
+
# Replay
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsSessionRecordingPlaylistsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/session_recording_playlists/`
|
|
8
|
+
- **What it does**: Override list to include synthetic playlists.
|
|
9
|
+
|
|
10
|
+
Synthetics have no DB row, so we compute each one's position in the merged
|
|
11
|
+
sort and split the requested page between synthetics and a DB queryset slice.
|
|
12
|
+
The merge/rank/sort is all in-memory, so each phase is wrapped in a span and
|
|
13
|
+
the input sizes are recorded as span attributes — a slow response on a team
|
|
14
|
+
with many playlists then shows up as a wide span against a large db_count.
|
|
15
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_list`
|
|
16
|
+
- **Path params**: None
|
|
17
|
+
- **Query params**: `created_by`, `limit`, `offset`, `short_id`
|
|
18
|
+
- **Response codes**: `200`
|
|
19
|
+
- **Transport options**: None
|
|
20
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
21
|
+
|
|
22
|
+
**Inputs**
|
|
23
|
+
|
|
24
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
25
|
+
- Client transport options: None
|
|
26
|
+
|
|
27
|
+
**Outputs**
|
|
28
|
+
|
|
29
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; ...`
|
|
30
|
+
- OpenAPI response codes: `200`
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import posthog from "@utdk/posthog";
|
|
34
|
+
|
|
35
|
+
type EnvironmentsSessionRecordingPlaylistsListInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
36
|
+
type EnvironmentsSessionRecordingPlaylistsListOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsList>>;
|
|
37
|
+
|
|
38
|
+
const result: EnvironmentsSessionRecordingPlaylistsListOutput = await posthog.environmentsSessionRecordingPlaylistsList();
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; ...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### `posthog.environmentsSessionRecordingPlaylistsCreate`
|
|
44
|
+
|
|
45
|
+
- **HTTP**: `POST /api/environments/{environment_id}/session_recording_playlists/`
|
|
46
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_create`
|
|
47
|
+
- **Path params**: None
|
|
48
|
+
- **Query params**: None
|
|
49
|
+
- **Response codes**: `201`
|
|
50
|
+
- **Transport options**: None
|
|
51
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
52
|
+
|
|
53
|
+
**Inputs**
|
|
54
|
+
|
|
55
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
56
|
+
- Client transport options: None
|
|
57
|
+
|
|
58
|
+
**Outputs**
|
|
59
|
+
|
|
60
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
61
|
+
- OpenAPI response codes: `201`
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import posthog from "@utdk/posthog";
|
|
65
|
+
|
|
66
|
+
type EnvironmentsSessionRecordingPlaylistsCreateInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
67
|
+
type EnvironmentsSessionRecordingPlaylistsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsCreate>>;
|
|
68
|
+
|
|
69
|
+
const result: EnvironmentsSessionRecordingPlaylistsCreateOutput = await posthog.environmentsSessionRecordingPlaylistsCreate();
|
|
70
|
+
|
|
71
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### `posthog.environmentsSessionRecordingPlaylistsDestroy`
|
|
75
|
+
|
|
76
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/session_recording_playlists/{short_id}/`
|
|
77
|
+
- **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
|
|
78
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_destroy`
|
|
79
|
+
- **Path params**: `short_id`
|
|
80
|
+
- **Query params**: None
|
|
81
|
+
- **Response codes**: `405`
|
|
82
|
+
- **Transport options**: None
|
|
83
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
84
|
+
|
|
85
|
+
**Inputs**
|
|
86
|
+
|
|
87
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
88
|
+
- Client transport options: None
|
|
89
|
+
|
|
90
|
+
**Outputs**
|
|
91
|
+
|
|
92
|
+
- Client return type: `unknown`
|
|
93
|
+
- OpenAPI response codes: `405`
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
import posthog from "@utdk/posthog";
|
|
97
|
+
|
|
98
|
+
type EnvironmentsSessionRecordingPlaylistsDestroyInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
99
|
+
type EnvironmentsSessionRecordingPlaylistsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsDestroy>>;
|
|
100
|
+
|
|
101
|
+
const result: EnvironmentsSessionRecordingPlaylistsDestroyOutput = await posthog.environmentsSessionRecordingPlaylistsDestroy();
|
|
102
|
+
|
|
103
|
+
// Result shape (from schema): unknown
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### `posthog.environmentsSessionRecordingPlaylistsRetrieve`
|
|
107
|
+
|
|
108
|
+
- **HTTP**: `GET /api/environments/{environment_id}/session_recording_playlists/{short_id}/`
|
|
109
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_retrieve`
|
|
110
|
+
- **Path params**: `short_id`
|
|
111
|
+
- **Query params**: None
|
|
112
|
+
- **Response codes**: `200`
|
|
113
|
+
- **Transport options**: None
|
|
114
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
115
|
+
|
|
116
|
+
**Inputs**
|
|
117
|
+
|
|
118
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
119
|
+
- Client transport options: None
|
|
120
|
+
|
|
121
|
+
**Outputs**
|
|
122
|
+
|
|
123
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
124
|
+
- OpenAPI response codes: `200`
|
|
125
|
+
|
|
126
|
+
```ts
|
|
127
|
+
import posthog from "@utdk/posthog";
|
|
128
|
+
|
|
129
|
+
type EnvironmentsSessionRecordingPlaylistsRetrieveInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
130
|
+
type EnvironmentsSessionRecordingPlaylistsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsRetrieve>>;
|
|
131
|
+
|
|
132
|
+
const result: EnvironmentsSessionRecordingPlaylistsRetrieveOutput = await posthog.environmentsSessionRecordingPlaylistsRetrieve();
|
|
133
|
+
|
|
134
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### `posthog.environmentsSessionRecordingPlaylistsPartialUpdate`
|
|
138
|
+
|
|
139
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/session_recording_playlists/{short_id}/`
|
|
140
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_partial_update`
|
|
141
|
+
- **Path params**: `short_id`
|
|
142
|
+
- **Query params**: None
|
|
143
|
+
- **Response codes**: `200`
|
|
144
|
+
- **Transport options**: None
|
|
145
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
146
|
+
|
|
147
|
+
**Inputs**
|
|
148
|
+
|
|
149
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
150
|
+
- Client transport options: None
|
|
151
|
+
|
|
152
|
+
**Outputs**
|
|
153
|
+
|
|
154
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
155
|
+
- OpenAPI response codes: `200`
|
|
156
|
+
|
|
157
|
+
```ts
|
|
158
|
+
import posthog from "@utdk/posthog";
|
|
159
|
+
|
|
160
|
+
type EnvironmentsSessionRecordingPlaylistsPartialUpdateInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
161
|
+
type EnvironmentsSessionRecordingPlaylistsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsPartialUpdate>>;
|
|
162
|
+
|
|
163
|
+
const result: EnvironmentsSessionRecordingPlaylistsPartialUpdateOutput = await posthog.environmentsSessionRecordingPlaylistsPartialUpdate();
|
|
164
|
+
|
|
165
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### `posthog.environmentsSessionRecordingPlaylistsUpdate`
|
|
169
|
+
|
|
170
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/session_recording_playlists/{short_id}/`
|
|
171
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_update`
|
|
172
|
+
- **Path params**: `short_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: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
186
|
+
- OpenAPI response codes: `200`
|
|
187
|
+
|
|
188
|
+
```ts
|
|
189
|
+
import posthog from "@utdk/posthog";
|
|
190
|
+
|
|
191
|
+
type EnvironmentsSessionRecordingPlaylistsUpdateInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
192
|
+
type EnvironmentsSessionRecordingPlaylistsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsUpdate>>;
|
|
193
|
+
|
|
194
|
+
const result: EnvironmentsSessionRecordingPlaylistsUpdateOutput = await posthog.environmentsSessionRecordingPlaylistsUpdate();
|
|
195
|
+
|
|
196
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### `posthog.environmentsSessionRecordingPlaylistsRecordingsRetrieve`
|
|
200
|
+
|
|
201
|
+
- **HTTP**: `GET /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/`
|
|
202
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_recordings_retrieve`
|
|
203
|
+
- **Path params**: `short_id`
|
|
204
|
+
- **Query params**: None
|
|
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: `unknown`
|
|
217
|
+
- OpenAPI response codes: `200`
|
|
218
|
+
|
|
219
|
+
```ts
|
|
220
|
+
import posthog from "@utdk/posthog";
|
|
221
|
+
|
|
222
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsRetrieveInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
223
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsRetrieve>>;
|
|
224
|
+
|
|
225
|
+
const result: EnvironmentsSessionRecordingPlaylistsRecordingsRetrieveOutput = await posthog.environmentsSessionRecordingPlaylistsRecordingsRetrieve();
|
|
226
|
+
|
|
227
|
+
// Result shape (from schema): unknown
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### `posthog.environmentsSessionRecordingPlaylistsRecordingsDestroy`
|
|
231
|
+
|
|
232
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/`
|
|
233
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_recordings_destroy`
|
|
234
|
+
- **Path params**: `session_recording_id`, `short_id`
|
|
235
|
+
- **Query params**: None
|
|
236
|
+
- **Response codes**: `204`
|
|
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: `unknown`
|
|
248
|
+
- OpenAPI response codes: `204`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsDestroyInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsDestroy>>;
|
|
255
|
+
|
|
256
|
+
const result: EnvironmentsSessionRecordingPlaylistsRecordingsDestroyOutput = await posthog.environmentsSessionRecordingPlaylistsRecordingsDestroy();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): unknown
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.environmentsSessionRecordingPlaylistsRecordingsCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/environments/{environment_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/`
|
|
264
|
+
- **OpenAPI operationId**: `environments_session_recording_playlists_recordings_create`
|
|
265
|
+
- **Path params**: `session_recording_id`, `short_id`
|
|
266
|
+
- **Query params**: None
|
|
267
|
+
- **Response codes**: `200`
|
|
268
|
+
- **Transport options**: None
|
|
269
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
270
|
+
|
|
271
|
+
**Inputs**
|
|
272
|
+
|
|
273
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
274
|
+
- Client transport options: None
|
|
275
|
+
|
|
276
|
+
**Outputs**
|
|
277
|
+
|
|
278
|
+
- Client return type: `unknown`
|
|
279
|
+
- OpenAPI response codes: `200`
|
|
280
|
+
|
|
281
|
+
```ts
|
|
282
|
+
import posthog from "@utdk/posthog";
|
|
283
|
+
|
|
284
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsCreateInput = Parameters<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
285
|
+
type EnvironmentsSessionRecordingPlaylistsRecordingsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingPlaylistsRecordingsCreate>>;
|
|
286
|
+
|
|
287
|
+
const result: EnvironmentsSessionRecordingPlaylistsRecordingsCreateOutput = await posthog.environmentsSessionRecordingPlaylistsRecordingsCreate();
|
|
288
|
+
|
|
289
|
+
// Result shape (from schema): unknown
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
### `posthog.environmentsSessionRecordingsList`
|
|
293
|
+
|
|
294
|
+
- **HTTP**: `GET /api/environments/{environment_id}/session_recordings/`
|
|
295
|
+
- **OpenAPI operationId**: `environments_session_recordings_list`
|
|
296
|
+
- **Path params**: None
|
|
297
|
+
- **Query params**: `limit`, `offset`
|
|
298
|
+
- **Response codes**: `200`
|
|
299
|
+
- **Transport options**: None
|
|
300
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
301
|
+
|
|
302
|
+
**Inputs**
|
|
303
|
+
|
|
304
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
305
|
+
- Client transport options: None
|
|
306
|
+
|
|
307
|
+
**Outputs**
|
|
308
|
+
|
|
309
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inact...`
|
|
310
|
+
- OpenAPI response codes: `200`
|
|
311
|
+
|
|
312
|
+
```ts
|
|
313
|
+
import posthog from "@utdk/posthog";
|
|
314
|
+
|
|
315
|
+
type EnvironmentsSessionRecordingsListInput = Parameters<typeof posthog.environmentsSessionRecordingsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
316
|
+
type EnvironmentsSessionRecordingsListOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsList>>;
|
|
317
|
+
|
|
318
|
+
const result: EnvironmentsSessionRecordingsListOutput = await posthog.environmentsSessionRecordingsList();
|
|
319
|
+
|
|
320
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inact...
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### `posthog.environmentsSessionRecordingsDestroy`
|
|
324
|
+
|
|
325
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/session_recordings/{id}/`
|
|
326
|
+
- **OpenAPI operationId**: `environments_session_recordings_destroy`
|
|
327
|
+
- **Path params**: `id`
|
|
328
|
+
- **Query params**: None
|
|
329
|
+
- **Response codes**: `204`
|
|
330
|
+
- **Transport options**: None
|
|
331
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
332
|
+
|
|
333
|
+
**Inputs**
|
|
334
|
+
|
|
335
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
336
|
+
- Client transport options: None
|
|
337
|
+
|
|
338
|
+
**Outputs**
|
|
339
|
+
|
|
340
|
+
- Client return type: `unknown`
|
|
341
|
+
- OpenAPI response codes: `204`
|
|
342
|
+
|
|
343
|
+
```ts
|
|
344
|
+
import posthog from "@utdk/posthog";
|
|
345
|
+
|
|
346
|
+
type EnvironmentsSessionRecordingsDestroyInput = Parameters<typeof posthog.environmentsSessionRecordingsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
347
|
+
type EnvironmentsSessionRecordingsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsDestroy>>;
|
|
348
|
+
|
|
349
|
+
const result: EnvironmentsSessionRecordingsDestroyOutput = await posthog.environmentsSessionRecordingsDestroy();
|
|
350
|
+
|
|
351
|
+
// Result shape (from schema): unknown
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
### `posthog.environmentsSessionRecordingsRetrieve`
|
|
355
|
+
|
|
356
|
+
- **HTTP**: `GET /api/environments/{environment_id}/session_recordings/{id}/`
|
|
357
|
+
- **OpenAPI operationId**: `environments_session_recordings_retrieve`
|
|
358
|
+
- **Path params**: `id`
|
|
359
|
+
- **Query params**: None
|
|
360
|
+
- **Response codes**: `200`
|
|
361
|
+
- **Transport options**: None
|
|
362
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
363
|
+
|
|
364
|
+
**Inputs**
|
|
365
|
+
|
|
366
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
367
|
+
- Client transport options: None
|
|
368
|
+
|
|
369
|
+
**Outputs**
|
|
370
|
+
|
|
371
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
372
|
+
- OpenAPI response codes: `200`
|
|
373
|
+
|
|
374
|
+
```ts
|
|
375
|
+
import posthog from "@utdk/posthog";
|
|
376
|
+
|
|
377
|
+
type EnvironmentsSessionRecordingsRetrieveInput = Parameters<typeof posthog.environmentsSessionRecordingsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
378
|
+
type EnvironmentsSessionRecordingsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsRetrieve>>;
|
|
379
|
+
|
|
380
|
+
const result: EnvironmentsSessionRecordingsRetrieveOutput = await posthog.environmentsSessionRecordingsRetrieve();
|
|
381
|
+
|
|
382
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### `posthog.environmentsSessionRecordingsPartialUpdate`
|
|
386
|
+
|
|
387
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/session_recordings/{id}/`
|
|
388
|
+
- **OpenAPI operationId**: `environments_session_recordings_partial_update`
|
|
389
|
+
- **Path params**: `id`
|
|
390
|
+
- **Query params**: None
|
|
391
|
+
- **Response codes**: `200`
|
|
392
|
+
- **Transport options**: None
|
|
393
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
394
|
+
|
|
395
|
+
**Inputs**
|
|
396
|
+
|
|
397
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
398
|
+
- Client transport options: None
|
|
399
|
+
|
|
400
|
+
**Outputs**
|
|
401
|
+
|
|
402
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
403
|
+
- OpenAPI response codes: `200`
|
|
404
|
+
|
|
405
|
+
```ts
|
|
406
|
+
import posthog from "@utdk/posthog";
|
|
407
|
+
|
|
408
|
+
type EnvironmentsSessionRecordingsPartialUpdateInput = Parameters<typeof posthog.environmentsSessionRecordingsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
409
|
+
type EnvironmentsSessionRecordingsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsPartialUpdate>>;
|
|
410
|
+
|
|
411
|
+
const result: EnvironmentsSessionRecordingsPartialUpdateOutput = await posthog.environmentsSessionRecordingsPartialUpdate();
|
|
412
|
+
|
|
413
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### `posthog.environmentsSessionRecordingsUpdate`
|
|
417
|
+
|
|
418
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/session_recordings/{id}/`
|
|
419
|
+
- **OpenAPI operationId**: `environments_session_recordings_update`
|
|
420
|
+
- **Path params**: `id`
|
|
421
|
+
- **Query params**: None
|
|
422
|
+
- **Response codes**: `200`
|
|
423
|
+
- **Transport options**: None
|
|
424
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
425
|
+
|
|
426
|
+
**Inputs**
|
|
427
|
+
|
|
428
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
429
|
+
- Client transport options: None
|
|
430
|
+
|
|
431
|
+
**Outputs**
|
|
432
|
+
|
|
433
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
434
|
+
- OpenAPI response codes: `200`
|
|
435
|
+
|
|
436
|
+
```ts
|
|
437
|
+
import posthog from "@utdk/posthog";
|
|
438
|
+
|
|
439
|
+
type EnvironmentsSessionRecordingsUpdateInput = Parameters<typeof posthog.environmentsSessionRecordingsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
440
|
+
type EnvironmentsSessionRecordingsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsUpdate>>;
|
|
441
|
+
|
|
442
|
+
const result: EnvironmentsSessionRecordingsUpdateOutput = await posthog.environmentsSessionRecordingsUpdate();
|
|
443
|
+
|
|
444
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
### `posthog.environmentsSessionRecordingsBulkDeleteCreate`
|
|
448
|
+
|
|
449
|
+
- **HTTP**: `POST /api/environments/{environment_id}/session_recordings/bulk_delete/`
|
|
450
|
+
- **What it does**: Delete a batch of session recordings by session ID. Deletion is permanent and cannot be undone. IDs that don't match an existing recording are skipped and counted in `total_requested` but not `deleted_count`.
|
|
451
|
+
- **OpenAPI operationId**: `environments_session_recordings_bulk_delete_create`
|
|
452
|
+
- **Path params**: None
|
|
453
|
+
- **Query params**: None
|
|
454
|
+
- **Response codes**: `200`
|
|
455
|
+
- **Transport options**: None
|
|
456
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
457
|
+
|
|
458
|
+
**Inputs**
|
|
459
|
+
|
|
460
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
461
|
+
- Client transport options: None
|
|
462
|
+
|
|
463
|
+
**Outputs**
|
|
464
|
+
|
|
465
|
+
- Client return type: `{ success: boolean; deleted_count: number; total_requested: number; failed_ids: (string)[] }`
|
|
466
|
+
- OpenAPI response codes: `200`
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
import posthog from "@utdk/posthog";
|
|
470
|
+
|
|
471
|
+
type EnvironmentsSessionRecordingsBulkDeleteCreateInput = Parameters<typeof posthog.environmentsSessionRecordingsBulkDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
472
|
+
type EnvironmentsSessionRecordingsBulkDeleteCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsBulkDeleteCreate>>;
|
|
473
|
+
|
|
474
|
+
const result: EnvironmentsSessionRecordingsBulkDeleteCreateOutput = await posthog.environmentsSessionRecordingsBulkDeleteCreate();
|
|
475
|
+
|
|
476
|
+
// Result shape (from schema): { success: boolean; deleted_count: number; total_requested: number; failed_ids: (string)[] }
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### `posthog.environmentsCreateSessionSummariesIndividually`
|
|
480
|
+
|
|
481
|
+
- **HTTP**: `POST /api/environments/{environment_id}/session_summaries/create_session_summaries_individually/`
|
|
482
|
+
- **What it does**: Generate AI individual summary for each session, without grouping.
|
|
483
|
+
- **OpenAPI operationId**: `environments_create_session_summaries_individually`
|
|
484
|
+
- **Path params**: None
|
|
485
|
+
- **Query params**: None
|
|
486
|
+
- **Response codes**: `200`
|
|
487
|
+
- **Transport options**: None
|
|
488
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
489
|
+
|
|
490
|
+
**Inputs**
|
|
491
|
+
|
|
492
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
493
|
+
- Client transport options: None
|
|
494
|
+
|
|
495
|
+
**Outputs**
|
|
496
|
+
|
|
497
|
+
- Client return type: `{ session_ids: (string)[]; focus_area?: string }`
|
|
498
|
+
- OpenAPI response codes: `200`
|
|
499
|
+
|
|
500
|
+
```ts
|
|
501
|
+
import posthog from "@utdk/posthog";
|
|
502
|
+
|
|
503
|
+
type EnvironmentsCreateSessionSummariesIndividuallyInput = Parameters<typeof posthog.environmentsCreateSessionSummariesIndividually> extends [infer T, ...unknown[]] ? T : undefined;
|
|
504
|
+
type EnvironmentsCreateSessionSummariesIndividuallyOutput = Awaited<ReturnType<typeof posthog.environmentsCreateSessionSummariesIndividually>>;
|
|
505
|
+
|
|
506
|
+
const result: EnvironmentsCreateSessionSummariesIndividuallyOutput = await posthog.environmentsCreateSessionSummariesIndividually();
|
|
507
|
+
|
|
508
|
+
// Result shape (from schema): { session_ids: (string)[]; focus_area?: string }
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
### `posthog.sessionRecordingPlaylistsList`
|
|
512
|
+
|
|
513
|
+
- **HTTP**: `GET /api/projects/{project_id}/session_recording_playlists/`
|
|
514
|
+
- **What it does**: Override list to include synthetic playlists.
|
|
515
|
+
|
|
516
|
+
Synthetics have no DB row, so we compute each one's position in the merged
|
|
517
|
+
sort and split the requested page between synthetics and a DB queryset slice.
|
|
518
|
+
The merge/rank/sort is all in-memory, so each phase is wrapped in a span and
|
|
519
|
+
the input sizes are recorded as span attributes — a slow response on a team
|
|
520
|
+
with many playlists then shows up as a wide span against a large db_count.
|
|
521
|
+
- **OpenAPI operationId**: `session_recording_playlists_list`
|
|
522
|
+
- **Path params**: None
|
|
523
|
+
- **Query params**: `created_by`, `limit`, `offset`, `short_id`
|
|
524
|
+
- **Response codes**: `200`
|
|
525
|
+
- **Transport options**: None
|
|
526
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
527
|
+
|
|
528
|
+
**Inputs**
|
|
529
|
+
|
|
530
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
531
|
+
- Client transport options: None
|
|
532
|
+
|
|
533
|
+
**Outputs**
|
|
534
|
+
|
|
535
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; ...`
|
|
536
|
+
- OpenAPI response codes: `200`
|
|
537
|
+
|
|
538
|
+
```ts
|
|
539
|
+
import posthog from "@utdk/posthog";
|
|
540
|
+
|
|
541
|
+
type SessionRecordingPlaylistsListInput = Parameters<typeof posthog.sessionRecordingPlaylistsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
542
|
+
type SessionRecordingPlaylistsListOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsList>>;
|
|
543
|
+
|
|
544
|
+
const result: SessionRecordingPlaylistsListOutput = await posthog.sessionRecordingPlaylistsList();
|
|
545
|
+
|
|
546
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; ...
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### `posthog.sessionRecordingPlaylistsCreate`
|
|
550
|
+
|
|
551
|
+
- **HTTP**: `POST /api/projects/{project_id}/session_recording_playlists/`
|
|
552
|
+
- **OpenAPI operationId**: `session_recording_playlists_create`
|
|
553
|
+
- **Path params**: None
|
|
554
|
+
- **Query params**: None
|
|
555
|
+
- **Response codes**: `201`
|
|
556
|
+
- **Transport options**: None
|
|
557
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
558
|
+
|
|
559
|
+
**Inputs**
|
|
560
|
+
|
|
561
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
562
|
+
- Client transport options: None
|
|
563
|
+
|
|
564
|
+
**Outputs**
|
|
565
|
+
|
|
566
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
567
|
+
- OpenAPI response codes: `201`
|
|
568
|
+
|
|
569
|
+
```ts
|
|
570
|
+
import posthog from "@utdk/posthog";
|
|
571
|
+
|
|
572
|
+
type SessionRecordingPlaylistsCreateInput = Parameters<typeof posthog.sessionRecordingPlaylistsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
573
|
+
type SessionRecordingPlaylistsCreateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsCreate>>;
|
|
574
|
+
|
|
575
|
+
const result: SessionRecordingPlaylistsCreateOutput = await posthog.sessionRecordingPlaylistsCreate();
|
|
576
|
+
|
|
577
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### `posthog.sessionRecordingPlaylistsDestroy`
|
|
581
|
+
|
|
582
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/`
|
|
583
|
+
- **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
|
|
584
|
+
- **OpenAPI operationId**: `session_recording_playlists_destroy`
|
|
585
|
+
- **Path params**: `short_id`
|
|
586
|
+
- **Query params**: None
|
|
587
|
+
- **Response codes**: `405`
|
|
588
|
+
- **Transport options**: None
|
|
589
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
590
|
+
|
|
591
|
+
**Inputs**
|
|
592
|
+
|
|
593
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
594
|
+
- Client transport options: None
|
|
595
|
+
|
|
596
|
+
**Outputs**
|
|
597
|
+
|
|
598
|
+
- Client return type: `unknown`
|
|
599
|
+
- OpenAPI response codes: `405`
|
|
600
|
+
|
|
601
|
+
```ts
|
|
602
|
+
import posthog from "@utdk/posthog";
|
|
603
|
+
|
|
604
|
+
type SessionRecordingPlaylistsDestroyInput = Parameters<typeof posthog.sessionRecordingPlaylistsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
605
|
+
type SessionRecordingPlaylistsDestroyOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsDestroy>>;
|
|
606
|
+
|
|
607
|
+
const result: SessionRecordingPlaylistsDestroyOutput = await posthog.sessionRecordingPlaylistsDestroy();
|
|
608
|
+
|
|
609
|
+
// Result shape (from schema): unknown
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
### `posthog.sessionRecordingPlaylistsRetrieve`
|
|
613
|
+
|
|
614
|
+
- **HTTP**: `GET /api/projects/{project_id}/session_recording_playlists/{short_id}/`
|
|
615
|
+
- **OpenAPI operationId**: `session_recording_playlists_retrieve`
|
|
616
|
+
- **Path params**: `short_id`
|
|
617
|
+
- **Query params**: None
|
|
618
|
+
- **Response codes**: `200`
|
|
619
|
+
- **Transport options**: None
|
|
620
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
621
|
+
|
|
622
|
+
**Inputs**
|
|
623
|
+
|
|
624
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
625
|
+
- Client transport options: None
|
|
626
|
+
|
|
627
|
+
**Outputs**
|
|
628
|
+
|
|
629
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
630
|
+
- OpenAPI response codes: `200`
|
|
631
|
+
|
|
632
|
+
```ts
|
|
633
|
+
import posthog from "@utdk/posthog";
|
|
634
|
+
|
|
635
|
+
type SessionRecordingPlaylistsRetrieveInput = Parameters<typeof posthog.sessionRecordingPlaylistsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
636
|
+
type SessionRecordingPlaylistsRetrieveOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsRetrieve>>;
|
|
637
|
+
|
|
638
|
+
const result: SessionRecordingPlaylistsRetrieveOutput = await posthog.sessionRecordingPlaylistsRetrieve();
|
|
639
|
+
|
|
640
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### `posthog.sessionRecordingPlaylistsPartialUpdate`
|
|
644
|
+
|
|
645
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/session_recording_playlists/{short_id}/`
|
|
646
|
+
- **OpenAPI operationId**: `session_recording_playlists_partial_update`
|
|
647
|
+
- **Path params**: `short_id`
|
|
648
|
+
- **Query params**: None
|
|
649
|
+
- **Response codes**: `200`
|
|
650
|
+
- **Transport options**: None
|
|
651
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
652
|
+
|
|
653
|
+
**Inputs**
|
|
654
|
+
|
|
655
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
656
|
+
- Client transport options: None
|
|
657
|
+
|
|
658
|
+
**Outputs**
|
|
659
|
+
|
|
660
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
661
|
+
- OpenAPI response codes: `200`
|
|
662
|
+
|
|
663
|
+
```ts
|
|
664
|
+
import posthog from "@utdk/posthog";
|
|
665
|
+
|
|
666
|
+
type SessionRecordingPlaylistsPartialUpdateInput = Parameters<typeof posthog.sessionRecordingPlaylistsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
667
|
+
type SessionRecordingPlaylistsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsPartialUpdate>>;
|
|
668
|
+
|
|
669
|
+
const result: SessionRecordingPlaylistsPartialUpdateOutput = await posthog.sessionRecordingPlaylistsPartialUpdate();
|
|
670
|
+
|
|
671
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
### `posthog.sessionRecordingPlaylistsUpdate`
|
|
675
|
+
|
|
676
|
+
- **HTTP**: `PUT /api/projects/{project_id}/session_recording_playlists/{short_id}/`
|
|
677
|
+
- **OpenAPI operationId**: `session_recording_playlists_update`
|
|
678
|
+
- **Path params**: `short_id`
|
|
679
|
+
- **Query params**: None
|
|
680
|
+
- **Response codes**: `200`
|
|
681
|
+
- **Transport options**: None
|
|
682
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
683
|
+
|
|
684
|
+
**Inputs**
|
|
685
|
+
|
|
686
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
687
|
+
- Client transport options: None
|
|
688
|
+
|
|
689
|
+
**Outputs**
|
|
690
|
+
|
|
691
|
+
- Client return type: `{ id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...`
|
|
692
|
+
- OpenAPI response codes: `200`
|
|
693
|
+
|
|
694
|
+
```ts
|
|
695
|
+
import posthog from "@utdk/posthog";
|
|
696
|
+
|
|
697
|
+
type SessionRecordingPlaylistsUpdateInput = Parameters<typeof posthog.sessionRecordingPlaylistsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
698
|
+
type SessionRecordingPlaylistsUpdateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsUpdate>>;
|
|
699
|
+
|
|
700
|
+
const result: SessionRecordingPlaylistsUpdateOutput = await posthog.sessionRecordingPlaylistsUpdate();
|
|
701
|
+
|
|
702
|
+
// Result shape (from schema): { id: number; short_id: string; name?: string | null; derived_name?: string | null; description?: string; pinned?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_...
|
|
703
|
+
```
|
|
704
|
+
|
|
705
|
+
### `posthog.sessionRecordingPlaylistsRecordingsRetrieve`
|
|
706
|
+
|
|
707
|
+
- **HTTP**: `GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/`
|
|
708
|
+
- **OpenAPI operationId**: `session_recording_playlists_recordings_retrieve`
|
|
709
|
+
- **Path params**: `short_id`
|
|
710
|
+
- **Query params**: None
|
|
711
|
+
- **Response codes**: `200`
|
|
712
|
+
- **Transport options**: None
|
|
713
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
714
|
+
|
|
715
|
+
**Inputs**
|
|
716
|
+
|
|
717
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
718
|
+
- Client transport options: None
|
|
719
|
+
|
|
720
|
+
**Outputs**
|
|
721
|
+
|
|
722
|
+
- Client return type: `unknown`
|
|
723
|
+
- OpenAPI response codes: `200`
|
|
724
|
+
|
|
725
|
+
```ts
|
|
726
|
+
import posthog from "@utdk/posthog";
|
|
727
|
+
|
|
728
|
+
type SessionRecordingPlaylistsRecordingsRetrieveInput = Parameters<typeof posthog.sessionRecordingPlaylistsRecordingsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
729
|
+
type SessionRecordingPlaylistsRecordingsRetrieveOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsRecordingsRetrieve>>;
|
|
730
|
+
|
|
731
|
+
const result: SessionRecordingPlaylistsRecordingsRetrieveOutput = await posthog.sessionRecordingPlaylistsRecordingsRetrieve();
|
|
732
|
+
|
|
733
|
+
// Result shape (from schema): unknown
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### `posthog.sessionRecordingPlaylistsRecordingsDestroy`
|
|
737
|
+
|
|
738
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/`
|
|
739
|
+
- **OpenAPI operationId**: `session_recording_playlists_recordings_destroy`
|
|
740
|
+
- **Path params**: `session_recording_id`, `short_id`
|
|
741
|
+
- **Query params**: None
|
|
742
|
+
- **Response codes**: `204`
|
|
743
|
+
- **Transport options**: None
|
|
744
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
745
|
+
|
|
746
|
+
**Inputs**
|
|
747
|
+
|
|
748
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
749
|
+
- Client transport options: None
|
|
750
|
+
|
|
751
|
+
**Outputs**
|
|
752
|
+
|
|
753
|
+
- Client return type: `unknown`
|
|
754
|
+
- OpenAPI response codes: `204`
|
|
755
|
+
|
|
756
|
+
```ts
|
|
757
|
+
import posthog from "@utdk/posthog";
|
|
758
|
+
|
|
759
|
+
type SessionRecordingPlaylistsRecordingsDestroyInput = Parameters<typeof posthog.sessionRecordingPlaylistsRecordingsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
760
|
+
type SessionRecordingPlaylistsRecordingsDestroyOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsRecordingsDestroy>>;
|
|
761
|
+
|
|
762
|
+
const result: SessionRecordingPlaylistsRecordingsDestroyOutput = await posthog.sessionRecordingPlaylistsRecordingsDestroy();
|
|
763
|
+
|
|
764
|
+
// Result shape (from schema): unknown
|
|
765
|
+
```
|
|
766
|
+
|
|
767
|
+
### `posthog.sessionRecordingPlaylistsRecordingsCreate`
|
|
768
|
+
|
|
769
|
+
- **HTTP**: `POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/`
|
|
770
|
+
- **OpenAPI operationId**: `session_recording_playlists_recordings_create`
|
|
771
|
+
- **Path params**: `session_recording_id`, `short_id`
|
|
772
|
+
- **Query params**: None
|
|
773
|
+
- **Response codes**: `200`
|
|
774
|
+
- **Transport options**: None
|
|
775
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
776
|
+
|
|
777
|
+
**Inputs**
|
|
778
|
+
|
|
779
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
780
|
+
- Client transport options: None
|
|
781
|
+
|
|
782
|
+
**Outputs**
|
|
783
|
+
|
|
784
|
+
- Client return type: `unknown`
|
|
785
|
+
- OpenAPI response codes: `200`
|
|
786
|
+
|
|
787
|
+
```ts
|
|
788
|
+
import posthog from "@utdk/posthog";
|
|
789
|
+
|
|
790
|
+
type SessionRecordingPlaylistsRecordingsCreateInput = Parameters<typeof posthog.sessionRecordingPlaylistsRecordingsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
791
|
+
type SessionRecordingPlaylistsRecordingsCreateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingPlaylistsRecordingsCreate>>;
|
|
792
|
+
|
|
793
|
+
const result: SessionRecordingPlaylistsRecordingsCreateOutput = await posthog.sessionRecordingPlaylistsRecordingsCreate();
|
|
794
|
+
|
|
795
|
+
// Result shape (from schema): unknown
|
|
796
|
+
```
|
|
797
|
+
|
|
798
|
+
### `posthog.sessionRecordingsList`
|
|
799
|
+
|
|
800
|
+
- **HTTP**: `GET /api/projects/{project_id}/session_recordings/`
|
|
801
|
+
- **OpenAPI operationId**: `session_recordings_list`
|
|
802
|
+
- **Path params**: None
|
|
803
|
+
- **Query params**: `limit`, `offset`
|
|
804
|
+
- **Response codes**: `200`
|
|
805
|
+
- **Transport options**: None
|
|
806
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
807
|
+
|
|
808
|
+
**Inputs**
|
|
809
|
+
|
|
810
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
811
|
+
- Client transport options: None
|
|
812
|
+
|
|
813
|
+
**Outputs**
|
|
814
|
+
|
|
815
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inact...`
|
|
816
|
+
- OpenAPI response codes: `200`
|
|
817
|
+
|
|
818
|
+
```ts
|
|
819
|
+
import posthog from "@utdk/posthog";
|
|
820
|
+
|
|
821
|
+
type SessionRecordingsListInput = Parameters<typeof posthog.sessionRecordingsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
822
|
+
type SessionRecordingsListOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsList>>;
|
|
823
|
+
|
|
824
|
+
const result: SessionRecordingsListOutput = await posthog.sessionRecordingsList();
|
|
825
|
+
|
|
826
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inact...
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
### `posthog.sessionRecordingsDestroy`
|
|
830
|
+
|
|
831
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/session_recordings/{id}/`
|
|
832
|
+
- **OpenAPI operationId**: `session_recordings_destroy`
|
|
833
|
+
- **Path params**: `id`
|
|
834
|
+
- **Query params**: None
|
|
835
|
+
- **Response codes**: `204`
|
|
836
|
+
- **Transport options**: None
|
|
837
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
838
|
+
|
|
839
|
+
**Inputs**
|
|
840
|
+
|
|
841
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
842
|
+
- Client transport options: None
|
|
843
|
+
|
|
844
|
+
**Outputs**
|
|
845
|
+
|
|
846
|
+
- Client return type: `unknown`
|
|
847
|
+
- OpenAPI response codes: `204`
|
|
848
|
+
|
|
849
|
+
```ts
|
|
850
|
+
import posthog from "@utdk/posthog";
|
|
851
|
+
|
|
852
|
+
type SessionRecordingsDestroyInput = Parameters<typeof posthog.sessionRecordingsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
853
|
+
type SessionRecordingsDestroyOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsDestroy>>;
|
|
854
|
+
|
|
855
|
+
const result: SessionRecordingsDestroyOutput = await posthog.sessionRecordingsDestroy();
|
|
856
|
+
|
|
857
|
+
// Result shape (from schema): unknown
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
### `posthog.sessionRecordingsRetrieve`
|
|
861
|
+
|
|
862
|
+
- **HTTP**: `GET /api/projects/{project_id}/session_recordings/{id}/`
|
|
863
|
+
- **OpenAPI operationId**: `session_recordings_retrieve`
|
|
864
|
+
- **Path params**: `id`
|
|
865
|
+
- **Query params**: None
|
|
866
|
+
- **Response codes**: `200`
|
|
867
|
+
- **Transport options**: None
|
|
868
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
869
|
+
|
|
870
|
+
**Inputs**
|
|
871
|
+
|
|
872
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
873
|
+
- Client transport options: None
|
|
874
|
+
|
|
875
|
+
**Outputs**
|
|
876
|
+
|
|
877
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
878
|
+
- OpenAPI response codes: `200`
|
|
879
|
+
|
|
880
|
+
```ts
|
|
881
|
+
import posthog from "@utdk/posthog";
|
|
882
|
+
|
|
883
|
+
type SessionRecordingsRetrieveInput = Parameters<typeof posthog.sessionRecordingsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
884
|
+
type SessionRecordingsRetrieveOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsRetrieve>>;
|
|
885
|
+
|
|
886
|
+
const result: SessionRecordingsRetrieveOutput = await posthog.sessionRecordingsRetrieve();
|
|
887
|
+
|
|
888
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
889
|
+
```
|
|
890
|
+
|
|
891
|
+
### `posthog.sessionRecordingsPartialUpdate`
|
|
892
|
+
|
|
893
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/session_recordings/{id}/`
|
|
894
|
+
- **OpenAPI operationId**: `session_recordings_partial_update`
|
|
895
|
+
- **Path params**: `id`
|
|
896
|
+
- **Query params**: None
|
|
897
|
+
- **Response codes**: `200`
|
|
898
|
+
- **Transport options**: None
|
|
899
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
900
|
+
|
|
901
|
+
**Inputs**
|
|
902
|
+
|
|
903
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
904
|
+
- Client transport options: None
|
|
905
|
+
|
|
906
|
+
**Outputs**
|
|
907
|
+
|
|
908
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
909
|
+
- OpenAPI response codes: `200`
|
|
910
|
+
|
|
911
|
+
```ts
|
|
912
|
+
import posthog from "@utdk/posthog";
|
|
913
|
+
|
|
914
|
+
type SessionRecordingsPartialUpdateInput = Parameters<typeof posthog.sessionRecordingsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
915
|
+
type SessionRecordingsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsPartialUpdate>>;
|
|
916
|
+
|
|
917
|
+
const result: SessionRecordingsPartialUpdateOutput = await posthog.sessionRecordingsPartialUpdate();
|
|
918
|
+
|
|
919
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
### `posthog.sessionRecordingsUpdate`
|
|
923
|
+
|
|
924
|
+
- **HTTP**: `PUT /api/projects/{project_id}/session_recordings/{id}/`
|
|
925
|
+
- **OpenAPI operationId**: `session_recordings_update`
|
|
926
|
+
- **Path params**: `id`
|
|
927
|
+
- **Query params**: None
|
|
928
|
+
- **Response codes**: `200`
|
|
929
|
+
- **Transport options**: None
|
|
930
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
931
|
+
|
|
932
|
+
**Inputs**
|
|
933
|
+
|
|
934
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
935
|
+
- Client transport options: None
|
|
936
|
+
|
|
937
|
+
**Outputs**
|
|
938
|
+
|
|
939
|
+
- Client return type: `{ id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...`
|
|
940
|
+
- OpenAPI response codes: `200`
|
|
941
|
+
|
|
942
|
+
```ts
|
|
943
|
+
import posthog from "@utdk/posthog";
|
|
944
|
+
|
|
945
|
+
type SessionRecordingsUpdateInput = Parameters<typeof posthog.sessionRecordingsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
946
|
+
type SessionRecordingsUpdateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsUpdate>>;
|
|
947
|
+
|
|
948
|
+
const result: SessionRecordingsUpdateOutput = await posthog.sessionRecordingsUpdate();
|
|
949
|
+
|
|
950
|
+
// Result shape (from schema): { id: string; distinct_id: string | null; viewed: boolean; viewers: (string)[]; recording_duration: number; active_seconds: number | null; inactive_seconds: number | null; start_time: string | null; end_time: string | n...
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
### `posthog.sessionRecordingsBulkDeleteCreate`
|
|
954
|
+
|
|
955
|
+
- **HTTP**: `POST /api/projects/{project_id}/session_recordings/bulk_delete/`
|
|
956
|
+
- **What it does**: Delete a batch of session recordings by session ID. Deletion is permanent and cannot be undone. IDs that don't match an existing recording are skipped and counted in `total_requested` but not `deleted_count`.
|
|
957
|
+
- **OpenAPI operationId**: `session_recordings_bulk_delete_create`
|
|
958
|
+
- **Path params**: None
|
|
959
|
+
- **Query params**: None
|
|
960
|
+
- **Response codes**: `200`
|
|
961
|
+
- **Transport options**: None
|
|
962
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
963
|
+
|
|
964
|
+
**Inputs**
|
|
965
|
+
|
|
966
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
967
|
+
- Client transport options: None
|
|
968
|
+
|
|
969
|
+
**Outputs**
|
|
970
|
+
|
|
971
|
+
- Client return type: `{ success: boolean; deleted_count: number; total_requested: number; failed_ids: (string)[] }`
|
|
972
|
+
- OpenAPI response codes: `200`
|
|
973
|
+
|
|
974
|
+
```ts
|
|
975
|
+
import posthog from "@utdk/posthog";
|
|
976
|
+
|
|
977
|
+
type SessionRecordingsBulkDeleteCreateInput = Parameters<typeof posthog.sessionRecordingsBulkDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
978
|
+
type SessionRecordingsBulkDeleteCreateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsBulkDeleteCreate>>;
|
|
979
|
+
|
|
980
|
+
const result: SessionRecordingsBulkDeleteCreateOutput = await posthog.sessionRecordingsBulkDeleteCreate();
|
|
981
|
+
|
|
982
|
+
// Result shape (from schema): { success: boolean; deleted_count: number; total_requested: number; failed_ids: (string)[] }
|
|
983
|
+
```
|
|
984
|
+
|
|
985
|
+
### `posthog.createSessionSummariesIndividually`
|
|
986
|
+
|
|
987
|
+
- **HTTP**: `POST /api/projects/{project_id}/session_summaries/create_session_summaries_individually/`
|
|
988
|
+
- **What it does**: Generate AI individual summary for each session, without grouping.
|
|
989
|
+
- **OpenAPI operationId**: `create_session_summaries_individually`
|
|
990
|
+
- **Path params**: None
|
|
991
|
+
- **Query params**: None
|
|
992
|
+
- **Response codes**: `200`
|
|
993
|
+
- **Transport options**: None
|
|
994
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
995
|
+
|
|
996
|
+
**Inputs**
|
|
997
|
+
|
|
998
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
999
|
+
- Client transport options: None
|
|
1000
|
+
|
|
1001
|
+
**Outputs**
|
|
1002
|
+
|
|
1003
|
+
- Client return type: `{ session_ids: (string)[]; focus_area?: string }`
|
|
1004
|
+
- OpenAPI response codes: `200`
|
|
1005
|
+
|
|
1006
|
+
```ts
|
|
1007
|
+
import posthog from "@utdk/posthog";
|
|
1008
|
+
|
|
1009
|
+
type CreateSessionSummariesIndividuallyInput = Parameters<typeof posthog.createSessionSummariesIndividually> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1010
|
+
type CreateSessionSummariesIndividuallyOutput = Awaited<ReturnType<typeof posthog.createSessionSummariesIndividually>>;
|
|
1011
|
+
|
|
1012
|
+
const result: CreateSessionSummariesIndividuallyOutput = await posthog.createSessionSummariesIndividually();
|
|
1013
|
+
|
|
1014
|
+
// Result shape (from schema): { session_ids: (string)[]; focus_area?: string }
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<!-- prompt-hash:
|
|
1019
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
1020
|
+
-->
|