@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.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
@@ -0,0 +1,104 @@
1
+ # Js Snippet
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.jsSnippetResolveRetrieve`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/js-snippet/resolve/`
8
+ - **What it does**: Preview what a given pin would resolve to, without saving it.
9
+ - **OpenAPI operationId**: `js_snippet_resolve_retrieve`
10
+ - **Path params**: None
11
+ - **Query params**: None
12
+ - **Response codes**: `200`
13
+ - **Transport options**: None
14
+ - **TypeScript**: [Client interface](../types.ts)
15
+
16
+ **Inputs**
17
+
18
+ - Client input type: `{ [key: string]: unknown }`
19
+ - Client transport options: None
20
+
21
+ **Outputs**
22
+
23
+ - Client return type: `{ [key: string]: unknown }`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type JsSnippetResolveRetrieveInput = Parameters<typeof posthog.jsSnippetResolveRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type JsSnippetResolveRetrieveOutput = Awaited<ReturnType<typeof posthog.jsSnippetResolveRetrieve>>;
31
+
32
+ const result: JsSnippetResolveRetrieveOutput = await posthog.jsSnippetResolveRetrieve();
33
+
34
+ // Result shape (from schema): { [key: string]: unknown }
35
+ ```
36
+
37
+ ### `posthog.jsSnippetVersionRetrieve`
38
+
39
+ - **HTTP**: `GET /api/projects/{project_id}/js-snippet/version/`
40
+ - **What it does**: Return the team's current version pin and resolved version.
41
+ - **OpenAPI operationId**: `js_snippet_version_retrieve`
42
+ - **Path params**: None
43
+ - **Query params**: None
44
+ - **Response codes**: `200`
45
+ - **Transport options**: None
46
+ - **TypeScript**: [Client interface](../types.ts)
47
+
48
+ **Inputs**
49
+
50
+ - Client input type: `{ [key: string]: unknown }`
51
+ - Client transport options: None
52
+
53
+ **Outputs**
54
+
55
+ - Client return type: `{ [key: string]: unknown }`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type JsSnippetVersionRetrieveInput = Parameters<typeof posthog.jsSnippetVersionRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type JsSnippetVersionRetrieveOutput = Awaited<ReturnType<typeof posthog.jsSnippetVersionRetrieve>>;
63
+
64
+ const result: JsSnippetVersionRetrieveOutput = await posthog.jsSnippetVersionRetrieve();
65
+
66
+ // Result shape (from schema): { [key: string]: unknown }
67
+ ```
68
+
69
+ ### `posthog.jsSnippetVersionPartialUpdate`
70
+
71
+ - **HTTP**: `PATCH /api/projects/{project_id}/js-snippet/version/`
72
+ - **What it does**: Update the team's version pin.
73
+ - **OpenAPI operationId**: `js_snippet_version_partial_update`
74
+ - **Path params**: None
75
+ - **Query params**: None
76
+ - **Response codes**: `200`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `{ [key: string]: unknown }`
88
+ - OpenAPI response codes: `200`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type JsSnippetVersionPartialUpdateInput = Parameters<typeof posthog.jsSnippetVersionPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type JsSnippetVersionPartialUpdateOutput = Awaited<ReturnType<typeof posthog.jsSnippetVersionPartialUpdate>>;
95
+
96
+ const result: JsSnippetVersionPartialUpdateOutput = await posthog.jsSnippetVersionPartialUpdate();
97
+
98
+ // Result shape (from schema): { [key: string]: unknown }
99
+ ```
100
+
101
+
102
+ <!-- prompt-hash:
103
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
104
+ -->
@@ -0,0 +1,264 @@
1
+ # Live Debugger Breakpoints
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.liveDebuggerBreakpointsList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/live_debugger_breakpoints/`
8
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
9
+ - **OpenAPI operationId**: `live_debugger_breakpoints_list`
10
+ - **Path params**: None
11
+ - **Query params**: `filename`, `limit`, `offset`, `repository`
12
+ - **Response codes**: `200`
13
+ - **Transport options**: None
14
+ - **TypeScript**: [Client interface](../types.ts)
15
+
16
+ **Inputs**
17
+
18
+ - Client input type: `{ [key: string]: unknown }`
19
+ - Client transport options: None
20
+
21
+ **Outputs**
22
+
23
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: strin...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type LiveDebuggerBreakpointsListInput = Parameters<typeof posthog.liveDebuggerBreakpointsList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type LiveDebuggerBreakpointsListOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsList>>;
31
+
32
+ const result: LiveDebuggerBreakpointsListOutput = await posthog.liveDebuggerBreakpointsList();
33
+
34
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: strin...
35
+ ```
36
+
37
+ ### `posthog.liveDebuggerBreakpointsCreate`
38
+
39
+ - **HTTP**: `POST /api/projects/{project_id}/live_debugger_breakpoints/`
40
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
41
+ - **OpenAPI operationId**: `live_debugger_breakpoints_create`
42
+ - **Path params**: None
43
+ - **Query params**: None
44
+ - **Response codes**: `201`
45
+ - **Transport options**: None
46
+ - **TypeScript**: [Client interface](../types.ts)
47
+
48
+ **Inputs**
49
+
50
+ - Client input type: `{ [key: string]: unknown }`
51
+ - Client transport options: None
52
+
53
+ **Outputs**
54
+
55
+ - Client return type: `{ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }`
56
+ - OpenAPI response codes: `201`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type LiveDebuggerBreakpointsCreateInput = Parameters<typeof posthog.liveDebuggerBreakpointsCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type LiveDebuggerBreakpointsCreateOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsCreate>>;
63
+
64
+ const result: LiveDebuggerBreakpointsCreateOutput = await posthog.liveDebuggerBreakpointsCreate();
65
+
66
+ // Result shape (from schema): { id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }
67
+ ```
68
+
69
+ ### `posthog.liveDebuggerBreakpointsDestroy`
70
+
71
+ - **HTTP**: `DELETE /api/projects/{project_id}/live_debugger_breakpoints/{id}/`
72
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
73
+ - **OpenAPI operationId**: `live_debugger_breakpoints_destroy`
74
+ - **Path params**: `id`
75
+ - **Query params**: None
76
+ - **Response codes**: `204`
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: `unknown`
88
+ - OpenAPI response codes: `204`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type LiveDebuggerBreakpointsDestroyInput = Parameters<typeof posthog.liveDebuggerBreakpointsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type LiveDebuggerBreakpointsDestroyOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsDestroy>>;
95
+
96
+ const result: LiveDebuggerBreakpointsDestroyOutput = await posthog.liveDebuggerBreakpointsDestroy();
97
+
98
+ // Result shape (from schema): unknown
99
+ ```
100
+
101
+ ### `posthog.liveDebuggerBreakpointsRetrieve`
102
+
103
+ - **HTTP**: `GET /api/projects/{project_id}/live_debugger_breakpoints/{id}/`
104
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
105
+ - **OpenAPI operationId**: `live_debugger_breakpoints_retrieve`
106
+ - **Path params**: `id`
107
+ - **Query params**: None
108
+ - **Response codes**: `200`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `{ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type LiveDebuggerBreakpointsRetrieveInput = Parameters<typeof posthog.liveDebuggerBreakpointsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type LiveDebuggerBreakpointsRetrieveOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsRetrieve>>;
127
+
128
+ const result: LiveDebuggerBreakpointsRetrieveOutput = await posthog.liveDebuggerBreakpointsRetrieve();
129
+
130
+ // Result shape (from schema): { id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }
131
+ ```
132
+
133
+ ### `posthog.liveDebuggerBreakpointsPartialUpdate`
134
+
135
+ - **HTTP**: `PATCH /api/projects/{project_id}/live_debugger_breakpoints/{id}/`
136
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
137
+ - **OpenAPI operationId**: `live_debugger_breakpoints_partial_update`
138
+ - **Path params**: `id`
139
+ - **Query params**: None
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type LiveDebuggerBreakpointsPartialUpdateInput = Parameters<typeof posthog.liveDebuggerBreakpointsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type LiveDebuggerBreakpointsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsPartialUpdate>>;
159
+
160
+ const result: LiveDebuggerBreakpointsPartialUpdateOutput = await posthog.liveDebuggerBreakpointsPartialUpdate();
161
+
162
+ // Result shape (from schema): { id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }
163
+ ```
164
+
165
+ ### `posthog.liveDebuggerBreakpointsUpdate`
166
+
167
+ - **HTTP**: `PUT /api/projects/{project_id}/live_debugger_breakpoints/{id}/`
168
+ - **What it does**: Create, Read, Update and Delete breakpoints for live debugging.
169
+ - **OpenAPI operationId**: `live_debugger_breakpoints_update`
170
+ - **Path params**: `id`
171
+ - **Query params**: None
172
+ - **Response codes**: `200`
173
+ - **Transport options**: None
174
+ - **TypeScript**: [Client interface](../types.ts)
175
+
176
+ **Inputs**
177
+
178
+ - Client input type: `{ [key: string]: unknown }`
179
+ - Client transport options: None
180
+
181
+ **Outputs**
182
+
183
+ - Client return type: `{ id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type LiveDebuggerBreakpointsUpdateInput = Parameters<typeof posthog.liveDebuggerBreakpointsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type LiveDebuggerBreakpointsUpdateOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsUpdate>>;
191
+
192
+ const result: LiveDebuggerBreakpointsUpdateOutput = await posthog.liveDebuggerBreakpointsUpdate();
193
+
194
+ // Result shape (from schema): { id: string; repository?: string | null; filename: string; line_number: number; enabled?: boolean; condition?: string | null; created_at: string; updated_at: string }
195
+ ```
196
+
197
+ ### `posthog.liveDebuggerBreakpointsActiveRetrieve`
198
+
199
+ - **HTTP**: `GET /api/projects/{project_id}/live_debugger_breakpoints/active/`
200
+ - **What it does**: Get active breakpoints (External API)
201
+ - **OpenAPI operationId**: `live_debugger_breakpoints_active_retrieve`
202
+ - **Path params**: None
203
+ - **Query params**: `enabled`, `filename`, `repository`
204
+ - **Response codes**: `200`, `400`, `401`
205
+ - **Transport options**: None
206
+ - **TypeScript**: [Client interface](../types.ts)
207
+
208
+ **Inputs**
209
+
210
+ - Client input type: `{ [key: string]: unknown }`
211
+ - Client transport options: None
212
+
213
+ **Outputs**
214
+
215
+ - Client return type: `{ breakpoints: ({ id: string; repository?: string | null; filename: string; line_number: number; enabled: boolean; condition?: string | null })[] }`
216
+ - OpenAPI response codes: `200`, `400`, `401`
217
+
218
+ ```ts
219
+ import posthog from "@utdk/posthog";
220
+
221
+ type LiveDebuggerBreakpointsActiveRetrieveInput = Parameters<typeof posthog.liveDebuggerBreakpointsActiveRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
222
+ type LiveDebuggerBreakpointsActiveRetrieveOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsActiveRetrieve>>;
223
+
224
+ const result: LiveDebuggerBreakpointsActiveRetrieveOutput = await posthog.liveDebuggerBreakpointsActiveRetrieve();
225
+
226
+ // Result shape (from schema): { breakpoints: ({ id: string; repository?: string | null; filename: string; line_number: number; enabled: boolean; condition?: string | null })[] }
227
+ ```
228
+
229
+ ### `posthog.liveDebuggerBreakpointsBreakpointHitsRetrieve`
230
+
231
+ - **HTTP**: `GET /api/projects/{project_id}/live_debugger_breakpoints/breakpoint_hits/`
232
+ - **What it does**: Get breakpoint hits
233
+ - **OpenAPI operationId**: `live_debugger_breakpoints_breakpoint_hits_retrieve`
234
+ - **Path params**: None
235
+ - **Query params**: `breakpoint_ids`, `limit`, `offset`
236
+ - **Response codes**: `200`, `400`
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: `{ results: ({ id: string; lineNumber: number; functionName: string; timestamp: string; variables: { [key: string]: unknown }; stackTrace: (unknown)[]; breakpoint_id: string; filename: string })[]; count: number; has_mor...`
248
+ - OpenAPI response codes: `200`, `400`
249
+
250
+ ```ts
251
+ import posthog from "@utdk/posthog";
252
+
253
+ type LiveDebuggerBreakpointsBreakpointHitsRetrieveInput = Parameters<typeof posthog.liveDebuggerBreakpointsBreakpointHitsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
254
+ type LiveDebuggerBreakpointsBreakpointHitsRetrieveOutput = Awaited<ReturnType<typeof posthog.liveDebuggerBreakpointsBreakpointHitsRetrieve>>;
255
+
256
+ const result: LiveDebuggerBreakpointsBreakpointHitsRetrieveOutput = await posthog.liveDebuggerBreakpointsBreakpointHitsRetrieve();
257
+
258
+ // Result shape (from schema): { results: ({ id: string; lineNumber: number; functionName: string; timestamp: string; variables: { [key: string]: unknown }; stackTrace: (unknown)[]; breakpoint_id: string; filename: string })[]; count: number; has_mor...
259
+ ```
260
+
261
+
262
+ <!-- prompt-hash:
263
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
264
+ -->