@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,808 @@
|
|
|
1
|
+
# Feature Flags
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.featureFlagsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/`
|
|
8
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
9
|
+
|
|
10
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
11
|
+
- **OpenAPI operationId**: `feature_flags_list`
|
|
12
|
+
- **Path params**: None
|
|
13
|
+
- **Query params**: `active`, `archived`, `created_by_id`, `evaluation_runtime`, `excluded_properties`, `excluded_tags`, `has_evaluation_contexts`, `limit`, `offset`, `search`, `tags`, `type`
|
|
14
|
+
- **Response codes**: `200`
|
|
15
|
+
- **Transport options**: None
|
|
16
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
17
|
+
|
|
18
|
+
**Inputs**
|
|
19
|
+
|
|
20
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
21
|
+
- Client transport options: None
|
|
22
|
+
|
|
23
|
+
**Outputs**
|
|
24
|
+
|
|
25
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created...`
|
|
26
|
+
- OpenAPI response codes: `200`
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import posthog from "@utdk/posthog";
|
|
30
|
+
|
|
31
|
+
type FeatureFlagsListInput = Parameters<typeof posthog.featureFlagsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
32
|
+
type FeatureFlagsListOutput = Awaited<ReturnType<typeof posthog.featureFlagsList>>;
|
|
33
|
+
|
|
34
|
+
const result: FeatureFlagsListOutput = await posthog.featureFlagsList();
|
|
35
|
+
|
|
36
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created...
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `posthog.featureFlagsCreate`
|
|
40
|
+
|
|
41
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/`
|
|
42
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
43
|
+
|
|
44
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
45
|
+
- **OpenAPI operationId**: `feature_flags_create`
|
|
46
|
+
- **Path params**: None
|
|
47
|
+
- **Query params**: None
|
|
48
|
+
- **Response codes**: `201`
|
|
49
|
+
- **Transport options**: None
|
|
50
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
51
|
+
|
|
52
|
+
**Inputs**
|
|
53
|
+
|
|
54
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
55
|
+
- Client transport options: None
|
|
56
|
+
|
|
57
|
+
**Outputs**
|
|
58
|
+
|
|
59
|
+
- Client return type: `{ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
|
|
60
|
+
- OpenAPI response codes: `201`
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import posthog from "@utdk/posthog";
|
|
64
|
+
|
|
65
|
+
type FeatureFlagsCreateInput = Parameters<typeof posthog.featureFlagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
66
|
+
type FeatureFlagsCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsCreate>>;
|
|
67
|
+
|
|
68
|
+
const result: FeatureFlagsCreateOutput = await posthog.featureFlagsCreate();
|
|
69
|
+
|
|
70
|
+
// Result shape (from schema): { id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### `posthog.featureFlagsDestroy`
|
|
74
|
+
|
|
75
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/feature_flags/{id}/`
|
|
76
|
+
- **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
|
|
77
|
+
- **OpenAPI operationId**: `feature_flags_destroy`
|
|
78
|
+
- **Path params**: `id`
|
|
79
|
+
- **Query params**: None
|
|
80
|
+
- **Response codes**: `405`
|
|
81
|
+
- **Transport options**: None
|
|
82
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
83
|
+
|
|
84
|
+
**Inputs**
|
|
85
|
+
|
|
86
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
87
|
+
- Client transport options: None
|
|
88
|
+
|
|
89
|
+
**Outputs**
|
|
90
|
+
|
|
91
|
+
- Client return type: `unknown`
|
|
92
|
+
- OpenAPI response codes: `405`
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import posthog from "@utdk/posthog";
|
|
96
|
+
|
|
97
|
+
type FeatureFlagsDestroyInput = Parameters<typeof posthog.featureFlagsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
98
|
+
type FeatureFlagsDestroyOutput = Awaited<ReturnType<typeof posthog.featureFlagsDestroy>>;
|
|
99
|
+
|
|
100
|
+
const result: FeatureFlagsDestroyOutput = await posthog.featureFlagsDestroy();
|
|
101
|
+
|
|
102
|
+
// Result shape (from schema): unknown
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### `posthog.featureFlagsRetrieve`
|
|
106
|
+
|
|
107
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/`
|
|
108
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
109
|
+
|
|
110
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
111
|
+
- **OpenAPI operationId**: `feature_flags_retrieve`
|
|
112
|
+
- **Path params**: `id`
|
|
113
|
+
- **Query params**: None
|
|
114
|
+
- **Response codes**: `200`
|
|
115
|
+
- **Transport options**: None
|
|
116
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
117
|
+
|
|
118
|
+
**Inputs**
|
|
119
|
+
|
|
120
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
121
|
+
- Client transport options: None
|
|
122
|
+
|
|
123
|
+
**Outputs**
|
|
124
|
+
|
|
125
|
+
- Client return type: `{ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
|
|
126
|
+
- OpenAPI response codes: `200`
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
import posthog from "@utdk/posthog";
|
|
130
|
+
|
|
131
|
+
type FeatureFlagsRetrieveInput = Parameters<typeof posthog.featureFlagsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
132
|
+
type FeatureFlagsRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsRetrieve>>;
|
|
133
|
+
|
|
134
|
+
const result: FeatureFlagsRetrieveOutput = await posthog.featureFlagsRetrieve();
|
|
135
|
+
|
|
136
|
+
// Result shape (from schema): { id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### `posthog.featureFlagsPartialUpdate`
|
|
140
|
+
|
|
141
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/feature_flags/{id}/`
|
|
142
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
143
|
+
|
|
144
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
145
|
+
- **OpenAPI operationId**: `feature_flags_partial_update`
|
|
146
|
+
- **Path params**: `id`
|
|
147
|
+
- **Query params**: None
|
|
148
|
+
- **Response codes**: `200`
|
|
149
|
+
- **Transport options**: None
|
|
150
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
151
|
+
|
|
152
|
+
**Inputs**
|
|
153
|
+
|
|
154
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
155
|
+
- Client transport options: None
|
|
156
|
+
|
|
157
|
+
**Outputs**
|
|
158
|
+
|
|
159
|
+
- Client return type: `{ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
|
|
160
|
+
- OpenAPI response codes: `200`
|
|
161
|
+
|
|
162
|
+
```ts
|
|
163
|
+
import posthog from "@utdk/posthog";
|
|
164
|
+
|
|
165
|
+
type FeatureFlagsPartialUpdateInput = Parameters<typeof posthog.featureFlagsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
166
|
+
type FeatureFlagsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.featureFlagsPartialUpdate>>;
|
|
167
|
+
|
|
168
|
+
const result: FeatureFlagsPartialUpdateOutput = await posthog.featureFlagsPartialUpdate();
|
|
169
|
+
|
|
170
|
+
// Result shape (from schema): { id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### `posthog.featureFlagsUpdate`
|
|
174
|
+
|
|
175
|
+
- **HTTP**: `PUT /api/projects/{project_id}/feature_flags/{id}/`
|
|
176
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
177
|
+
|
|
178
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
179
|
+
- **OpenAPI operationId**: `feature_flags_update`
|
|
180
|
+
- **Path params**: `id`
|
|
181
|
+
- **Query params**: None
|
|
182
|
+
- **Response codes**: `200`
|
|
183
|
+
- **Transport options**: None
|
|
184
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
185
|
+
|
|
186
|
+
**Inputs**
|
|
187
|
+
|
|
188
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
189
|
+
- Client transport options: None
|
|
190
|
+
|
|
191
|
+
**Outputs**
|
|
192
|
+
|
|
193
|
+
- Client return type: `{ id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
|
|
194
|
+
- OpenAPI response codes: `200`
|
|
195
|
+
|
|
196
|
+
```ts
|
|
197
|
+
import posthog from "@utdk/posthog";
|
|
198
|
+
|
|
199
|
+
type FeatureFlagsUpdateInput = Parameters<typeof posthog.featureFlagsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
200
|
+
type FeatureFlagsUpdateOutput = Awaited<ReturnType<typeof posthog.featureFlagsUpdate>>;
|
|
201
|
+
|
|
202
|
+
const result: FeatureFlagsUpdateOutput = await posthog.featureFlagsUpdate();
|
|
203
|
+
|
|
204
|
+
// Result shape (from schema): { id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; archived?: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### `posthog.featureFlagsActivityRetrieve`
|
|
208
|
+
|
|
209
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/activity/`
|
|
210
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
211
|
+
|
|
212
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
213
|
+
- **OpenAPI operationId**: `feature_flags_activity_retrieve`
|
|
214
|
+
- **Path params**: `id`
|
|
215
|
+
- **Query params**: `limit`, `page`
|
|
216
|
+
- **Response codes**: `200`, `404`
|
|
217
|
+
- **Transport options**: None
|
|
218
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
219
|
+
|
|
220
|
+
**Inputs**
|
|
221
|
+
|
|
222
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
223
|
+
- Client transport options: None
|
|
224
|
+
|
|
225
|
+
**Outputs**
|
|
226
|
+
|
|
227
|
+
- Client return type: `{ results: ({ id: string; user: { [key: string]: unknown } | null; activity: string; scope: string; item_id: string; detail?: { id: string; changes?: ({ type: string; action: string; field: string; before: unknown; afte...`
|
|
228
|
+
- OpenAPI response codes: `200`, `404`
|
|
229
|
+
|
|
230
|
+
```ts
|
|
231
|
+
import posthog from "@utdk/posthog";
|
|
232
|
+
|
|
233
|
+
type FeatureFlagsActivityRetrieveInput = Parameters<typeof posthog.featureFlagsActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
234
|
+
type FeatureFlagsActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsActivityRetrieve>>;
|
|
235
|
+
|
|
236
|
+
const result: FeatureFlagsActivityRetrieveOutput = await posthog.featureFlagsActivityRetrieve();
|
|
237
|
+
|
|
238
|
+
// Result shape (from schema): { results: ({ id: string; user: { [key: string]: unknown } | null; activity: string; scope: string; item_id: string; detail?: { id: string; changes?: ({ type: string; action: string; field: string; before: unknown; afte...
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### `posthog.featureFlagsCreateStaticCohortForFlagCreate`
|
|
242
|
+
|
|
243
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/{id}/create_static_cohort_for_flag/`
|
|
244
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
245
|
+
|
|
246
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
247
|
+
- **OpenAPI operationId**: `feature_flags_create_static_cohort_for_flag_create`
|
|
248
|
+
- **Path params**: `id`
|
|
249
|
+
- **Query params**: None
|
|
250
|
+
- **Response codes**: `200`
|
|
251
|
+
- **Transport options**: None
|
|
252
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
253
|
+
|
|
254
|
+
**Inputs**
|
|
255
|
+
|
|
256
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
257
|
+
- Client transport options: None
|
|
258
|
+
|
|
259
|
+
**Outputs**
|
|
260
|
+
|
|
261
|
+
- Client return type: `unknown`
|
|
262
|
+
- OpenAPI response codes: `200`
|
|
263
|
+
|
|
264
|
+
```ts
|
|
265
|
+
import posthog from "@utdk/posthog";
|
|
266
|
+
|
|
267
|
+
type FeatureFlagsCreateStaticCohortForFlagCreateInput = Parameters<typeof posthog.featureFlagsCreateStaticCohortForFlagCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
268
|
+
type FeatureFlagsCreateStaticCohortForFlagCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsCreateStaticCohortForFlagCreate>>;
|
|
269
|
+
|
|
270
|
+
const result: FeatureFlagsCreateStaticCohortForFlagCreateOutput = await posthog.featureFlagsCreateStaticCohortForFlagCreate();
|
|
271
|
+
|
|
272
|
+
// Result shape (from schema): unknown
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### `posthog.featureFlagsDashboardCreate`
|
|
276
|
+
|
|
277
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/{id}/dashboard/`
|
|
278
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
279
|
+
|
|
280
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
281
|
+
- **OpenAPI operationId**: `feature_flags_dashboard_create`
|
|
282
|
+
- **Path params**: `id`
|
|
283
|
+
- **Query params**: None
|
|
284
|
+
- **Response codes**: `200`
|
|
285
|
+
- **Transport options**: None
|
|
286
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
287
|
+
|
|
288
|
+
**Inputs**
|
|
289
|
+
|
|
290
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
291
|
+
- Client transport options: None
|
|
292
|
+
|
|
293
|
+
**Outputs**
|
|
294
|
+
|
|
295
|
+
- Client return type: `unknown`
|
|
296
|
+
- OpenAPI response codes: `200`
|
|
297
|
+
|
|
298
|
+
```ts
|
|
299
|
+
import posthog from "@utdk/posthog";
|
|
300
|
+
|
|
301
|
+
type FeatureFlagsDashboardCreateInput = Parameters<typeof posthog.featureFlagsDashboardCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
302
|
+
type FeatureFlagsDashboardCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsDashboardCreate>>;
|
|
303
|
+
|
|
304
|
+
const result: FeatureFlagsDashboardCreateOutput = await posthog.featureFlagsDashboardCreate();
|
|
305
|
+
|
|
306
|
+
// Result shape (from schema): unknown
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### `posthog.featureFlagsDependentFlagsList`
|
|
310
|
+
|
|
311
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/dependent_flags/`
|
|
312
|
+
- **What it does**: Get other active flags that depend on this flag.
|
|
313
|
+
- **OpenAPI operationId**: `feature_flags_dependent_flags_list`
|
|
314
|
+
- **Path params**: `id`
|
|
315
|
+
- **Query params**: None
|
|
316
|
+
- **Response codes**: `200`
|
|
317
|
+
- **Transport options**: None
|
|
318
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
319
|
+
|
|
320
|
+
**Inputs**
|
|
321
|
+
|
|
322
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
323
|
+
- Client transport options: None
|
|
324
|
+
|
|
325
|
+
**Outputs**
|
|
326
|
+
|
|
327
|
+
- Client return type: `({ id: number; key: string; name: string })[]`
|
|
328
|
+
- OpenAPI response codes: `200`
|
|
329
|
+
|
|
330
|
+
```ts
|
|
331
|
+
import posthog from "@utdk/posthog";
|
|
332
|
+
|
|
333
|
+
type FeatureFlagsDependentFlagsListInput = Parameters<typeof posthog.featureFlagsDependentFlagsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
334
|
+
type FeatureFlagsDependentFlagsListOutput = Awaited<ReturnType<typeof posthog.featureFlagsDependentFlagsList>>;
|
|
335
|
+
|
|
336
|
+
const result: FeatureFlagsDependentFlagsListOutput = await posthog.featureFlagsDependentFlagsList();
|
|
337
|
+
|
|
338
|
+
// Result shape (from schema): ({ id: number; key: string; name: string })[]
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### `posthog.featureFlagsEnrichUsageDashboardCreate`
|
|
342
|
+
|
|
343
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/{id}/enrich_usage_dashboard/`
|
|
344
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
345
|
+
|
|
346
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
347
|
+
- **OpenAPI operationId**: `feature_flags_enrich_usage_dashboard_create`
|
|
348
|
+
- **Path params**: `id`
|
|
349
|
+
- **Query params**: None
|
|
350
|
+
- **Response codes**: `200`
|
|
351
|
+
- **Transport options**: None
|
|
352
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
353
|
+
|
|
354
|
+
**Inputs**
|
|
355
|
+
|
|
356
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
357
|
+
- Client transport options: None
|
|
358
|
+
|
|
359
|
+
**Outputs**
|
|
360
|
+
|
|
361
|
+
- Client return type: `unknown`
|
|
362
|
+
- OpenAPI response codes: `200`
|
|
363
|
+
|
|
364
|
+
```ts
|
|
365
|
+
import posthog from "@utdk/posthog";
|
|
366
|
+
|
|
367
|
+
type FeatureFlagsEnrichUsageDashboardCreateInput = Parameters<typeof posthog.featureFlagsEnrichUsageDashboardCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
368
|
+
type FeatureFlagsEnrichUsageDashboardCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsEnrichUsageDashboardCreate>>;
|
|
369
|
+
|
|
370
|
+
const result: FeatureFlagsEnrichUsageDashboardCreateOutput = await posthog.featureFlagsEnrichUsageDashboardCreate();
|
|
371
|
+
|
|
372
|
+
// Result shape (from schema): unknown
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### `posthog.featureFlagsRemoteConfigRetrieve`
|
|
376
|
+
|
|
377
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/remote_config/`
|
|
378
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
379
|
+
|
|
380
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
381
|
+
- **OpenAPI operationId**: `feature_flags_remote_config_retrieve`
|
|
382
|
+
- **Path params**: `id`
|
|
383
|
+
- **Query params**: None
|
|
384
|
+
- **Response codes**: `200`
|
|
385
|
+
- **Transport options**: None
|
|
386
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
387
|
+
|
|
388
|
+
**Inputs**
|
|
389
|
+
|
|
390
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
391
|
+
- Client transport options: None
|
|
392
|
+
|
|
393
|
+
**Outputs**
|
|
394
|
+
|
|
395
|
+
- Client return type: `unknown`
|
|
396
|
+
- OpenAPI response codes: `200`
|
|
397
|
+
|
|
398
|
+
```ts
|
|
399
|
+
import posthog from "@utdk/posthog";
|
|
400
|
+
|
|
401
|
+
type FeatureFlagsRemoteConfigRetrieveInput = Parameters<typeof posthog.featureFlagsRemoteConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
402
|
+
type FeatureFlagsRemoteConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsRemoteConfigRetrieve>>;
|
|
403
|
+
|
|
404
|
+
const result: FeatureFlagsRemoteConfigRetrieveOutput = await posthog.featureFlagsRemoteConfigRetrieve();
|
|
405
|
+
|
|
406
|
+
// Result shape (from schema): unknown
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
### `posthog.featureFlagsStatusRetrieve`
|
|
410
|
+
|
|
411
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/status/`
|
|
412
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
413
|
+
|
|
414
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
415
|
+
- **OpenAPI operationId**: `feature_flags_status_retrieve`
|
|
416
|
+
- **Path params**: `id`
|
|
417
|
+
- **Query params**: None
|
|
418
|
+
- **Response codes**: `200`
|
|
419
|
+
- **Transport options**: None
|
|
420
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
421
|
+
|
|
422
|
+
**Inputs**
|
|
423
|
+
|
|
424
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
425
|
+
- Client transport options: None
|
|
426
|
+
|
|
427
|
+
**Outputs**
|
|
428
|
+
|
|
429
|
+
- Client return type: `{ status: string; reason: string; rollout: { effectively_full_rollout: boolean; has_targeting_conditions: boolean; max_rollout_percentage: number | null; is_multivariate: boolean } }`
|
|
430
|
+
- OpenAPI response codes: `200`
|
|
431
|
+
|
|
432
|
+
```ts
|
|
433
|
+
import posthog from "@utdk/posthog";
|
|
434
|
+
|
|
435
|
+
type FeatureFlagsStatusRetrieveInput = Parameters<typeof posthog.featureFlagsStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
436
|
+
type FeatureFlagsStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsStatusRetrieve>>;
|
|
437
|
+
|
|
438
|
+
const result: FeatureFlagsStatusRetrieveOutput = await posthog.featureFlagsStatusRetrieve();
|
|
439
|
+
|
|
440
|
+
// Result shape (from schema): { status: string; reason: string; rollout: { effectively_full_rollout: boolean; has_targeting_conditions: boolean; max_rollout_percentage: number | null; is_multivariate: boolean } }
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### `posthog.featureFlagsTestEvaluationCreate`
|
|
444
|
+
|
|
445
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/{id}/test_evaluation/`
|
|
446
|
+
- **What it does**: Test feature flag evaluation against a specific user at an optional point in time.
|
|
447
|
+
|
|
448
|
+
This endpoint allows testing how a feature flag would evaluate for a specific user,
|
|
449
|
+
optionally at a historical timestamp. When a timestamp is provided, both the flag
|
|
450
|
+
conditions and person properties are evaluated as they existed at that time.
|
|
451
|
+
- **OpenAPI operationId**: `feature_flags_test_evaluation_create`
|
|
452
|
+
- **Path params**: `id`
|
|
453
|
+
- **Query params**: None
|
|
454
|
+
- **Response codes**: `200`, `400`, `404`, `500`, `502`
|
|
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: `{ flag_key: string; result: unknown; reason: string; condition_index: number | null; payload: unknown; person_properties: { [key: string]: unknown }; evaluation_distinct_id: string | null; conditions: ({ index: number; ...`
|
|
466
|
+
- OpenAPI response codes: `200`, `400`, `404`, `500`, `502`
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
import posthog from "@utdk/posthog";
|
|
470
|
+
|
|
471
|
+
type FeatureFlagsTestEvaluationCreateInput = Parameters<typeof posthog.featureFlagsTestEvaluationCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
472
|
+
type FeatureFlagsTestEvaluationCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsTestEvaluationCreate>>;
|
|
473
|
+
|
|
474
|
+
const result: FeatureFlagsTestEvaluationCreateOutput = await posthog.featureFlagsTestEvaluationCreate();
|
|
475
|
+
|
|
476
|
+
// Result shape (from schema): { flag_key: string; result: unknown; reason: string; condition_index: number | null; payload: unknown; person_properties: { [key: string]: unknown }; evaluation_distinct_id: string | null; conditions: ({ index: number; ...
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### `posthog.featureFlagsVersionsRetrieve`
|
|
480
|
+
|
|
481
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/{id}/versions/{version_number}/`
|
|
482
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
483
|
+
|
|
484
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
485
|
+
- **OpenAPI operationId**: `feature_flags_versions_retrieve`
|
|
486
|
+
- **Path params**: `id`, `version_number`
|
|
487
|
+
- **Query params**: None
|
|
488
|
+
- **Response codes**: `200`, `400`, `404`, `422`
|
|
489
|
+
- **Transport options**: None
|
|
490
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
491
|
+
|
|
492
|
+
**Inputs**
|
|
493
|
+
|
|
494
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
495
|
+
- Client transport options: None
|
|
496
|
+
|
|
497
|
+
**Outputs**
|
|
498
|
+
|
|
499
|
+
- Client return type: `{ id: number; key: string; name?: string; filters: { [key: string]: unknown }; active?: boolean; deleted?: boolean; version?: number | null; rollback_conditions?: unknown; performed_rollback?: boolean | null; ensure_exp...`
|
|
500
|
+
- OpenAPI response codes: `200`, `400`, `404`, `422`
|
|
501
|
+
|
|
502
|
+
```ts
|
|
503
|
+
import posthog from "@utdk/posthog";
|
|
504
|
+
|
|
505
|
+
type FeatureFlagsVersionsRetrieveInput = Parameters<typeof posthog.featureFlagsVersionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
506
|
+
type FeatureFlagsVersionsRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsVersionsRetrieve>>;
|
|
507
|
+
|
|
508
|
+
const result: FeatureFlagsVersionsRetrieveOutput = await posthog.featureFlagsVersionsRetrieve();
|
|
509
|
+
|
|
510
|
+
// Result shape (from schema): { id: number; key: string; name?: string; filters: { [key: string]: unknown }; active?: boolean; deleted?: boolean; version?: number | null; rollback_conditions?: unknown; performed_rollback?: boolean | null; ensure_exp...
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
### `posthog.featureFlagsAllActivityRetrieve`
|
|
514
|
+
|
|
515
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/activity/`
|
|
516
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
517
|
+
|
|
518
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
519
|
+
- **OpenAPI operationId**: `feature_flags_all_activity_retrieve`
|
|
520
|
+
- **Path params**: None
|
|
521
|
+
- **Query params**: `limit`, `page`
|
|
522
|
+
- **Response codes**: `200`
|
|
523
|
+
- **Transport options**: None
|
|
524
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
525
|
+
|
|
526
|
+
**Inputs**
|
|
527
|
+
|
|
528
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
529
|
+
- Client transport options: None
|
|
530
|
+
|
|
531
|
+
**Outputs**
|
|
532
|
+
|
|
533
|
+
- Client return type: `{ results: ({ id: string; user: { [key: string]: unknown } | null; activity: string; scope: string; item_id: string; detail?: { id: string; changes?: ({ type: string; action: string; field: string; before: unknown; afte...`
|
|
534
|
+
- OpenAPI response codes: `200`
|
|
535
|
+
|
|
536
|
+
```ts
|
|
537
|
+
import posthog from "@utdk/posthog";
|
|
538
|
+
|
|
539
|
+
type FeatureFlagsAllActivityRetrieveInput = Parameters<typeof posthog.featureFlagsAllActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
540
|
+
type FeatureFlagsAllActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsAllActivityRetrieve>>;
|
|
541
|
+
|
|
542
|
+
const result: FeatureFlagsAllActivityRetrieveOutput = await posthog.featureFlagsAllActivityRetrieve();
|
|
543
|
+
|
|
544
|
+
// Result shape (from schema): { results: ({ id: string; user: { [key: string]: unknown } | null; activity: string; scope: string; item_id: string; detail?: { id: string; changes?: ({ type: string; action: string; field: string; before: unknown; afte...
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### `posthog.featureFlagsBulkDeleteCreate`
|
|
548
|
+
|
|
549
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/bulk_delete/`
|
|
550
|
+
- **What it does**: Bulk delete feature flags by filter criteria or explicit IDs.
|
|
551
|
+
|
|
552
|
+
Accepts either:
|
|
553
|
+
- {"filters": {...}} - Same filter params as list endpoint (search, active, type, etc.)
|
|
554
|
+
- {"ids": [...]} - Explicit list of flag IDs (no limit)
|
|
555
|
+
|
|
556
|
+
Returns same format as bulk_delete for UI compatibility.
|
|
557
|
+
|
|
558
|
+
Uses bulk operations for efficiency: database updates are batched and cache
|
|
559
|
+
invalidation happens once at the end rather than per-flag.
|
|
560
|
+
- **OpenAPI operationId**: `feature_flags_bulk_delete_create`
|
|
561
|
+
- **Path params**: None
|
|
562
|
+
- **Query params**: None
|
|
563
|
+
- **Response codes**: `200`, `400`
|
|
564
|
+
- **Transport options**: None
|
|
565
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
566
|
+
|
|
567
|
+
**Inputs**
|
|
568
|
+
|
|
569
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
570
|
+
- Client transport options: None
|
|
571
|
+
|
|
572
|
+
**Outputs**
|
|
573
|
+
|
|
574
|
+
- Client return type: `{ deleted: ({ id: number; key: string; rollout_state: "fully_rolled_out" | "not_rolled_out" | "partial"; active_variant: string | null })[]; errors: ({ id: unknown; key?: string; reason: string })[] }`
|
|
575
|
+
- OpenAPI response codes: `200`, `400`
|
|
576
|
+
|
|
577
|
+
```ts
|
|
578
|
+
import posthog from "@utdk/posthog";
|
|
579
|
+
|
|
580
|
+
type FeatureFlagsBulkDeleteCreateInput = Parameters<typeof posthog.featureFlagsBulkDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
581
|
+
type FeatureFlagsBulkDeleteCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsBulkDeleteCreate>>;
|
|
582
|
+
|
|
583
|
+
const result: FeatureFlagsBulkDeleteCreateOutput = await posthog.featureFlagsBulkDeleteCreate();
|
|
584
|
+
|
|
585
|
+
// Result shape (from schema): { deleted: ({ id: number; key: string; rollout_state: "fully_rolled_out" | "not_rolled_out" | "partial"; active_variant: string | null })[]; errors: ({ id: unknown; key?: string; reason: string })[] }
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### `posthog.featureFlagsBulkKeysRetrieve`
|
|
589
|
+
|
|
590
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/bulk_keys/`
|
|
591
|
+
- **What it does**: Get feature flag keys by IDs.
|
|
592
|
+
Accepts a list of feature flag IDs and returns a mapping of ID to key.
|
|
593
|
+
- **OpenAPI operationId**: `feature_flags_bulk_keys_retrieve`
|
|
594
|
+
- **Path params**: None
|
|
595
|
+
- **Query params**: None
|
|
596
|
+
- **Response codes**: `200`, `400`
|
|
597
|
+
- **Transport options**: None
|
|
598
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
599
|
+
|
|
600
|
+
**Inputs**
|
|
601
|
+
|
|
602
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
603
|
+
- Client transport options: None
|
|
604
|
+
|
|
605
|
+
**Outputs**
|
|
606
|
+
|
|
607
|
+
- Client return type: `{ keys: { [key: string]: string | undefined }; warning?: string }`
|
|
608
|
+
- OpenAPI response codes: `200`, `400`
|
|
609
|
+
|
|
610
|
+
```ts
|
|
611
|
+
import posthog from "@utdk/posthog";
|
|
612
|
+
|
|
613
|
+
type FeatureFlagsBulkKeysRetrieveInput = Parameters<typeof posthog.featureFlagsBulkKeysRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
614
|
+
type FeatureFlagsBulkKeysRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsBulkKeysRetrieve>>;
|
|
615
|
+
|
|
616
|
+
const result: FeatureFlagsBulkKeysRetrieveOutput = await posthog.featureFlagsBulkKeysRetrieve();
|
|
617
|
+
|
|
618
|
+
// Result shape (from schema): { keys: { [key: string]: string | undefined }; warning?: string }
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
### `posthog.featureFlagsBulkUpdateTagsCreate`
|
|
622
|
+
|
|
623
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/bulk_update_tags/`
|
|
624
|
+
- **What it does**: Bulk update tags on multiple objects.
|
|
625
|
+
|
|
626
|
+
PAT access: this action has no ``required_scopes=`` on the decorator —
|
|
627
|
+
inheriting viewsets must add ``"bulk_update_tags"`` to their
|
|
628
|
+
``scope_object_write_actions`` list to accept personal API keys.
|
|
629
|
+
Without that opt-in, ``APIScopePermission`` rejects PAT requests with
|
|
630
|
+
"This action does not support personal API key access". Done per-viewset
|
|
631
|
+
so granting ``<scope>:write`` for one resource doesn't leak access to
|
|
632
|
+
sibling resources that share this mixin.
|
|
633
|
+
|
|
634
|
+
Accepts:
|
|
635
|
+
- {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}
|
|
636
|
+
|
|
637
|
+
Actions:
|
|
638
|
+
- "add": Add tags to existing tags on each object
|
|
639
|
+
- "remove": Remove specific tags from each object
|
|
640
|
+
- "set": Replace all tags on each object with the provided list
|
|
641
|
+
- **OpenAPI operationId**: `feature_flags_bulk_update_tags_create`
|
|
642
|
+
- **Path params**: None
|
|
643
|
+
- **Query params**: None
|
|
644
|
+
- **Response codes**: `200`
|
|
645
|
+
- **Transport options**: None
|
|
646
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
647
|
+
|
|
648
|
+
**Inputs**
|
|
649
|
+
|
|
650
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
651
|
+
- Client transport options: None
|
|
652
|
+
|
|
653
|
+
**Outputs**
|
|
654
|
+
|
|
655
|
+
- Client return type: `{ updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }`
|
|
656
|
+
- OpenAPI response codes: `200`
|
|
657
|
+
|
|
658
|
+
```ts
|
|
659
|
+
import posthog from "@utdk/posthog";
|
|
660
|
+
|
|
661
|
+
type FeatureFlagsBulkUpdateTagsCreateInput = Parameters<typeof posthog.featureFlagsBulkUpdateTagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
662
|
+
type FeatureFlagsBulkUpdateTagsCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsBulkUpdateTagsCreate>>;
|
|
663
|
+
|
|
664
|
+
const result: FeatureFlagsBulkUpdateTagsCreateOutput = await posthog.featureFlagsBulkUpdateTagsCreate();
|
|
665
|
+
|
|
666
|
+
// Result shape (from schema): { updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
### `posthog.featureFlagsEvaluationReasonsRetrieve`
|
|
670
|
+
|
|
671
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/evaluation_reasons/`
|
|
672
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
673
|
+
|
|
674
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
675
|
+
- **OpenAPI operationId**: `feature_flags_evaluation_reasons_retrieve`
|
|
676
|
+
- **Path params**: None
|
|
677
|
+
- **Query params**: `distinct_id`, `groups`
|
|
678
|
+
- **Response codes**: `200`
|
|
679
|
+
- **Transport options**: None
|
|
680
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
681
|
+
|
|
682
|
+
**Inputs**
|
|
683
|
+
|
|
684
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
685
|
+
- Client transport options: None
|
|
686
|
+
|
|
687
|
+
**Outputs**
|
|
688
|
+
|
|
689
|
+
- Client return type: `unknown`
|
|
690
|
+
- OpenAPI response codes: `200`
|
|
691
|
+
|
|
692
|
+
```ts
|
|
693
|
+
import posthog from "@utdk/posthog";
|
|
694
|
+
|
|
695
|
+
type FeatureFlagsEvaluationReasonsRetrieveInput = Parameters<typeof posthog.featureFlagsEvaluationReasonsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
696
|
+
type FeatureFlagsEvaluationReasonsRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsEvaluationReasonsRetrieve>>;
|
|
697
|
+
|
|
698
|
+
const result: FeatureFlagsEvaluationReasonsRetrieveOutput = await posthog.featureFlagsEvaluationReasonsRetrieve();
|
|
699
|
+
|
|
700
|
+
// Result shape (from schema): unknown
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
### `posthog.featureFlagsMatchingIdsRetrieve`
|
|
704
|
+
|
|
705
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/matching_ids/`
|
|
706
|
+
- **What it does**: Get IDs of all feature flags matching the current filters.
|
|
707
|
+
Uses the same filtering logic as the list endpoint.
|
|
708
|
+
Returns only IDs that the user has permission to edit.
|
|
709
|
+
- **OpenAPI operationId**: `feature_flags_matching_ids_retrieve`
|
|
710
|
+
- **Path params**: None
|
|
711
|
+
- **Query params**: None
|
|
712
|
+
- **Response codes**: `200`
|
|
713
|
+
- **Transport options**: None
|
|
714
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
715
|
+
|
|
716
|
+
**Inputs**
|
|
717
|
+
|
|
718
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
719
|
+
- Client transport options: None
|
|
720
|
+
|
|
721
|
+
**Outputs**
|
|
722
|
+
|
|
723
|
+
- Client return type: `unknown`
|
|
724
|
+
- OpenAPI response codes: `200`
|
|
725
|
+
|
|
726
|
+
```ts
|
|
727
|
+
import posthog from "@utdk/posthog";
|
|
728
|
+
|
|
729
|
+
type FeatureFlagsMatchingIdsRetrieveInput = Parameters<typeof posthog.featureFlagsMatchingIdsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
730
|
+
type FeatureFlagsMatchingIdsRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsMatchingIdsRetrieve>>;
|
|
731
|
+
|
|
732
|
+
const result: FeatureFlagsMatchingIdsRetrieveOutput = await posthog.featureFlagsMatchingIdsRetrieve();
|
|
733
|
+
|
|
734
|
+
// Result shape (from schema): unknown
|
|
735
|
+
```
|
|
736
|
+
|
|
737
|
+
### `posthog.featureFlagsMyFlagsRetrieve`
|
|
738
|
+
|
|
739
|
+
- **HTTP**: `GET /api/projects/{project_id}/feature_flags/my_flags/`
|
|
740
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
741
|
+
|
|
742
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
743
|
+
- **OpenAPI operationId**: `feature_flags_my_flags_retrieve`
|
|
744
|
+
- **Path params**: None
|
|
745
|
+
- **Query params**: `groups`
|
|
746
|
+
- **Response codes**: `200`
|
|
747
|
+
- **Transport options**: None
|
|
748
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
749
|
+
|
|
750
|
+
**Inputs**
|
|
751
|
+
|
|
752
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
753
|
+
- Client transport options: None
|
|
754
|
+
|
|
755
|
+
**Outputs**
|
|
756
|
+
|
|
757
|
+
- Client return type: `({ feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: number | nu...`
|
|
758
|
+
- OpenAPI response codes: `200`
|
|
759
|
+
|
|
760
|
+
```ts
|
|
761
|
+
import posthog from "@utdk/posthog";
|
|
762
|
+
|
|
763
|
+
type FeatureFlagsMyFlagsRetrieveInput = Parameters<typeof posthog.featureFlagsMyFlagsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
764
|
+
type FeatureFlagsMyFlagsRetrieveOutput = Awaited<ReturnType<typeof posthog.featureFlagsMyFlagsRetrieve>>;
|
|
765
|
+
|
|
766
|
+
const result: FeatureFlagsMyFlagsRetrieveOutput = await posthog.featureFlagsMyFlagsRetrieve();
|
|
767
|
+
|
|
768
|
+
// Result shape (from schema): ({ feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: number | nu...
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
### `posthog.featureFlagsUserBlastRadiusCreate`
|
|
772
|
+
|
|
773
|
+
- **HTTP**: `POST /api/projects/{project_id}/feature_flags/user_blast_radius/`
|
|
774
|
+
- **What it does**: Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.
|
|
775
|
+
|
|
776
|
+
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
|
|
777
|
+
- **OpenAPI operationId**: `feature_flags_user_blast_radius_create`
|
|
778
|
+
- **Path params**: None
|
|
779
|
+
- **Query params**: None
|
|
780
|
+
- **Response codes**: `200`
|
|
781
|
+
- **Transport options**: None
|
|
782
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
783
|
+
|
|
784
|
+
**Inputs**
|
|
785
|
+
|
|
786
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
787
|
+
- Client transport options: None
|
|
788
|
+
|
|
789
|
+
**Outputs**
|
|
790
|
+
|
|
791
|
+
- Client return type: `{ affected: number; total: number }`
|
|
792
|
+
- OpenAPI response codes: `200`
|
|
793
|
+
|
|
794
|
+
```ts
|
|
795
|
+
import posthog from "@utdk/posthog";
|
|
796
|
+
|
|
797
|
+
type FeatureFlagsUserBlastRadiusCreateInput = Parameters<typeof posthog.featureFlagsUserBlastRadiusCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
798
|
+
type FeatureFlagsUserBlastRadiusCreateOutput = Awaited<ReturnType<typeof posthog.featureFlagsUserBlastRadiusCreate>>;
|
|
799
|
+
|
|
800
|
+
const result: FeatureFlagsUserBlastRadiusCreateOutput = await posthog.featureFlagsUserBlastRadiusCreate();
|
|
801
|
+
|
|
802
|
+
// Result shape (from schema): { affected: number; total: number }
|
|
803
|
+
```
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<!-- prompt-hash:
|
|
807
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
808
|
+
-->
|