-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgrowthbook-openapi.yaml
3632 lines (3615 loc) · 114 KB
/
growthbook-openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
version: 1.0.0
title: GrowthBook REST API
description: |
GrowthBook offers a full REST API for interacting with the GrowthBook application. This is currently in **beta** as we add more authenticated API routes and features.
Request data can use either JSON or Form data encoding (with proper `Content-Type` headers). All response bodies are JSON-encoded.
The API base URL for GrowthBook Cloud is `https://api.growthbook.io`. For self-hosted deployments, it is the same as your API_HOST environment variable (defaults to `http://localhost:3100`). The rest of these docs will assume you are using GrowthBook Cloud.
## Authentication
We support both the HTTP Basic and Bearer authentication schemes for convenience.
You first need to generate a new API Key in GrowthBook. Different keys have different permissions:
- **Personal Access Tokens**: These are sensitive and provide the same level of access as the user has to an organization. These can be created by going to `Personal Access Tokens` under the your user menu.
- **Secret Keys**: These are sensitive and provide the level of access for the role, which currently is either `admin` or `readonly`. Only Admins with the `manageApiKeys` permission can manage Secret Keys on behalf of an organization. These can be created by going to `Settings -> API Keys`
If using HTTP Basic auth, pass the Secret Key as the username and leave the password blank:
```bash
curl https://api.growthbook.io/api/v1 \
-u secret_abc123DEF456:
# The ":" at the end stops curl from asking for a password
```
If using Bearer auth, pass the Secret Key as the token:
```bash
curl https://api.growthbook.io/api/v1 \
-H "Authorization: Bearer secret_abc123DEF456"
```
## Errors
The API may return the following error status codes:
- **400** - Bad Request - Often due to a missing required parameter
- **401** - Unauthorized - No valid API key provided
- **402** - Request Failed - The parameters are valid, but the request failed
- **403** - Forbidden - Provided API key does not have the required access
- **404** - Not Found - Unknown API route or requested resource
- **429** - Too Many Requests - You exceeded the rate limit of 60 requests per minute. Try again later.
- **5XX** - Server Error - Something went wrong on GrowthBook's end (these are rare)
The response body will be a JSON object with the following properties:
- **message** - Information about the error
servers:
- url: 'https://api.growthbook.io/api/v1'
description: GrowthBook Cloud
- url: '{domain}/api/v1'
description: Self-hosted GrowthBook
variables:
domain:
default: 'http://localhost:3100'
tags:
- name: projects
x-displayName: Projects
description: Projects are used to organize your feature flags and experiments
- name: features
x-displayName: Feature Flags
description: Control your feature flags programatically
- name: data-sources
x-displayName: Data Sources
description: How GrowthBook connects and queries your data
- name: metrics
x-displayName: Metrics
description: Metrics used as goals and guardrails for experiments
- name: experiments
x-displayName: Experiments
description: Experiments (A/B Tests)
- name: dimensions
x-displayName: Dimensions
description: Dimensions used during experiment analysis
- name: segments
x-displayName: Segments
description: Segments used during experiment analysis
- name: sdk-connections
x-displayName: SDK Connections
description: Client keys and settings for connecting SDKs to a GrowthBook instance
- name: visual-changesets
x-displayName: Visual Changesets
description: Groups of visual changes made by the visual editor to a single page
- name: saved-groups
x-displayName: Saved Groups
description: Defined sets of attribute values which can be used with feature rules for targeting features at particular users.
- name: organizations
x-displayName: Organizations
description: Organizations are used for multi-org deployments where different teams can run their own isolated feature flags and experiments. These endpoints are only via a super-admin's Personal Access Token.
- name: DataSource_model
x-displayName: DataSource
description: <SchemaDefinition schemaRef="#/components/schemas/DataSource" />
- name: Dimension_model
x-displayName: Dimension
description: <SchemaDefinition schemaRef="#/components/schemas/Dimension" />
- name: Experiment_model
x-displayName: Experiment
description: <SchemaDefinition schemaRef="#/components/schemas/Experiment" />
- name: ExperimentAnalysisSettings_model
x-displayName: ExperimentAnalysisSettings
description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentAnalysisSettings" />
- name: ExperimentMetric_model
x-displayName: ExperimentMetric
description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentMetric" />
- name: ExperimentResults_model
x-displayName: ExperimentResults
description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentResults" />
- name: Feature_model
x-displayName: Feature
description: <SchemaDefinition schemaRef="#/components/schemas/Feature" />
- name: FeatureDefinition_model
x-displayName: FeatureDefinition
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureDefinition" />
- name: FeatureEnvironment_model
x-displayName: FeatureEnvironment
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureEnvironment" />
- name: FeatureExperimentRefRule_model
x-displayName: FeatureExperimentRefRule
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureExperimentRefRule" />
- name: FeatureExperimentRule_model
x-displayName: FeatureExperimentRule
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureExperimentRule" />
- name: FeatureForceRule_model
x-displayName: FeatureForceRule
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureForceRule" />
- name: FeatureRolloutRule_model
x-displayName: FeatureRolloutRule
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRolloutRule" />
- name: FeatureRule_model
x-displayName: FeatureRule
description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRule" />
- name: Metric_model
x-displayName: Metric
description: <SchemaDefinition schemaRef="#/components/schemas/Metric" />
- name: Organization_model
x-displayName: Organization
description: <SchemaDefinition schemaRef="#/components/schemas/Organization" />
- name: PaginationFields_model
x-displayName: PaginationFields
description: <SchemaDefinition schemaRef="#/components/schemas/PaginationFields" />
- name: Project_model
x-displayName: Project
description: <SchemaDefinition schemaRef="#/components/schemas/Project" />
- name: SavedGroup_model
x-displayName: SavedGroup
description: <SchemaDefinition schemaRef="#/components/schemas/SavedGroup" />
- name: SdkConnection_model
x-displayName: SdkConnection
description: <SchemaDefinition schemaRef="#/components/schemas/SdkConnection" />
- name: Segment_model
x-displayName: Segment
description: <SchemaDefinition schemaRef="#/components/schemas/Segment" />
- name: VisualChange_model
x-displayName: VisualChange
description: <SchemaDefinition schemaRef="#/components/schemas/VisualChange" />
- name: VisualChangeset_model
x-displayName: VisualChangeset
description: <SchemaDefinition schemaRef="#/components/schemas/VisualChangeset" />
paths:
/features:
get:
summary: Get all features
tags:
- features
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/projectId'
operationId: listFeatures
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/features \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- features
properties:
features:
type: array
items:
$ref: '#/components/schemas/Feature'
- $ref: '#/components/schemas/PaginationFields'
post:
summary: Create a single feature
parameters: []
tags:
- features
operationId: postFeature
x-codeSamples:
- lang: cURL
source: |
curl -X POST https://api.growthbook.io/api/v1/features \
-d '{ id: "test-01", description: "A cool feature", ... }'
-u secret_abc123DEF456:
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- owner
- valueType
- defaultValue
properties:
id:
type: string
description: 'A unique key name for the feature. Feature keys can only include letters, numbers, hyphens, and underscores.'
archived:
type: boolean
description:
type: string
description: Description of the feature
owner:
type: string
description: Email of the person who owns this experiment
project:
type: string
description: An associated project ID
valueType:
type: string
description: The data type of the feature payload. Boolean by default.
enum:
- boolean
- string
- number
- json
defaultValue:
description: Default value when feature is enabled. Type must match `valueType`.
type: string
tags:
type: array
items:
type: string
description: List of associated tags
environments:
type: object
description: A dictionary of environments that are enabled for this feature. Keys supply the names of environments. Environments belong to organization and are not specified will be disabled by default.
additionalProperties:
type: object
required:
- enabled
- rules
properties:
enabled:
type: boolean
rules:
type: array
items:
anyOf:
- type: object
required:
- type
- value
properties:
description:
type: string
condition:
type: string
description: Applied to everyone by default.
savedGroupTargeting:
type: array
items:
type: object
required:
- matchType
- savedGroups
properties:
matchType:
type: string
enum:
- all
- any
- none
savedGroups:
type: array
items:
type: string
id:
type: string
enabled:
type: boolean
description: Enabled by default
type:
type: string
enum:
- force
value:
type: string
- type: object
required:
- type
- value
- coverage
- hashAttribute
properties:
description:
type: string
condition:
type: string
description: Applied to everyone by default.
savedGroupTargeting:
type: array
items:
type: object
required:
- matchType
- savedGroups
properties:
matchType:
type: string
enum:
- all
- any
- none
savedGroups:
type: array
items:
type: string
id:
type: string
enabled:
type: boolean
description: Enabled by default
type:
type: string
enum:
- rollout
value:
type: string
coverage:
type: number
description: Percent of traffic included in this experiment. Users not included in the experiment will skip this rule.
hashAttribute:
type: string
- type: object
required:
- type
- variations
- experimentId
properties:
description:
type: string
id:
type: string
enabled:
type: boolean
description: Enabled by default
type:
type: string
enum:
- experiment-ref
condition:
type: string
variations:
type: array
items:
type: object
required:
- value
- variationId
properties:
value:
type: string
variationId:
type: string
experimentId:
type: string
definition:
type: string
description: 'A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model)'
draft:
type: object
description: Use to write draft changes without publishing them.
required:
- rules
properties:
enabled:
type: boolean
rules:
type: array
items:
$ref: '#/paths/~1features/post/requestBody/content/application~1json/schema/properties/environments/additionalProperties/properties/rules/items'
definition:
type: string
description: 'A JSON stringified [FeatureDefinition](#tag/FeatureDefinition_model)'
jsonSchema:
type: string
description: Use JSON schema to validate the payload of a JSON-type feature value (enterprise only).
responses:
'200':
content:
application/json:
schema:
type: object
required:
- feature
properties:
feature:
$ref: '#/components/schemas/Feature'
'/features/{id}':
get:
parameters:
- $ref: '#/components/parameters/id'
summary: Get a single feature
tags:
- features
operationId: getFeature
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/features/my_feature \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- feature
properties:
feature:
$ref: '#/components/schemas/Feature'
post:
summary: Partially update a feature
parameters:
- $ref: '#/components/parameters/id'
tags:
- features
operationId: updateFeature
x-codeSamples:
- lang: cURL
source: |
curl -X POST https://api.growthbook.io/api/v1/features/test-01 \
-d '{ description: "A cool feature flag", ... }'
-u secret_abc123DEF456:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: Description of the feature
archived:
type: boolean
project:
type: string
description: An associated project ID
owner:
type: string
defaultValue:
type: string
tags:
type: array
items:
type: string
description: List of associated tags. Will override tags completely with submitted list
environments:
type: object
additionalProperties:
$ref: '#/paths/~1features/post/requestBody/content/application~1json/schema/properties/environments/additionalProperties'
jsonSchema:
type: string
description: Use JSON schema to validate the payload of a JSON-type feature value (enterprise only).
responses:
'200':
content:
application/json:
schema:
type: object
required:
- feature
properties:
feature:
$ref: '#/components/schemas/Feature'
'/features/{id}/toggle':
parameters:
- $ref: '#/components/parameters/id'
post:
summary: Toggle a feature in one or more environments
tags:
- features
operationId: toggleFeature
x-codeSamples:
- lang: cURL
source: |
curl -X POST https://api.growthbook.io/api/v1/features/my-feature/toggle \
-u secret_abc123DEF456: \
-d "environments[production]"=false \
-d reason="Kill switch activated"
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- environments
properties:
reason:
type: string
environments:
type: object
additionalProperties:
enum:
- true
- false
- 'true'
- 'false'
- '1'
- '0'
- 1
- 0
- ''
responses:
'200':
content:
application/json:
schema:
type: object
required:
- feature
properties:
feature:
$ref: '#/components/schemas/Feature'
/projects:
get:
summary: Get all projects
tags:
- projects
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
operationId: listProjects
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/projects \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- projects
properties:
projects:
type: array
items:
$ref: '#/components/schemas/Project'
- $ref: '#/components/schemas/PaginationFields'
'/projects/{id}':
parameters:
- $ref: '#/components/parameters/id'
get:
summary: Get a single project
tags:
- projects
operationId: getProject
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/projects/prj_123abc \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- project
properties:
project:
$ref: '#/components/schemas/Project'
/dimensions:
get:
summary: Get all dimensions
tags:
- dimensions
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/datasourceId'
operationId: listDimensions
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/dimensions \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- dimensions
properties:
dimensions:
type: array
items:
$ref: '#/components/schemas/Dimension'
- $ref: '#/components/schemas/PaginationFields'
'/dimensions/{id}':
parameters:
- $ref: '#/components/parameters/id'
get:
summary: Get a single dimension
tags:
- dimensions
operationId: getDimension
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/dimensions/dim_123abc \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- dimension
properties:
dimension:
$ref: '#/components/schemas/Dimension'
/segments:
get:
summary: Get all segments
tags:
- segments
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/datasourceId'
operationId: listSegments
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/segments \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- segments
properties:
segments:
type: array
items:
$ref: '#/components/schemas/Segment'
- $ref: '#/components/schemas/PaginationFields'
'/segments/{id}':
parameters:
- $ref: '#/components/parameters/id'
get:
summary: Get a single segment
tags:
- segments
operationId: getSegment
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/segments/seg_123abc \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- segment
properties:
segment:
$ref: '#/components/schemas/Segment'
/sdk-connections:
get:
summary: Get all sdk connections
tags:
- sdk-connections
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/projectId'
- name: withProxy
in: query
schema:
type: string
- name: multiOrg
in: query
schema:
type: string
operationId: listSdkConnections
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/sdk-connections \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- sdkConnections
properties:
connections:
type: array
items:
$ref: '#/components/schemas/SdkConnection'
- $ref: '#/components/schemas/PaginationFields'
'/sdk-connections/{id}':
parameters:
- $ref: '#/components/parameters/id'
get:
summary: Get a single sdk connection
tags:
- sdk-connections
operationId: getSdkConnection
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/sdk-connections/sdk_123abc \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- sdkConnection
properties:
sdkConnection:
$ref: '#/components/schemas/SdkConnection'
/data-sources:
get:
summary: Get all data sources
tags:
- data-sources
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/projectId'
operationId: listDataSources
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/data-sources \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- dataSources
properties:
dataSources:
type: array
items:
$ref: '#/components/schemas/DataSource'
- $ref: '#/components/schemas/PaginationFields'
'/data-sources/{id}':
parameters:
- $ref: '#/components/parameters/id'
get:
tags:
- data-sources
summary: Get a single data source
operationId: getDataSource
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/data-sources/ds_123abc \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
type: object
required:
- dataSource
properties:
dataSource:
$ref: '#/components/schemas/DataSource'
/experiments:
get:
summary: Get all experiments
tags:
- experiments
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/projectId'
- $ref: '#/components/parameters/datasourceId'
- name: experimentId
in: query
description: Filter the returned list by the experiment tracking key (id)
schema:
type: string
operationId: listExperiments
x-codeSamples:
- lang: cURL
source: |
curl https://api.growthbook.io/api/v1/experiments \
-u secret_abc123DEF456:
responses:
'200':
content:
application/json:
schema:
allOf:
- type: object
required:
- experiments
properties:
experiments:
type: array
items:
$ref: '#/components/schemas/Experiment'
- $ref: '#/components/schemas/PaginationFields'
post:
parameters: []
tags:
- experiments
summary: Create a single experiment
operationId: postExperiment
x-codeSamples:
- lang: cURL
source: |
curl -X POST https://api.growthbook.io/api/v1/experiments \
-d '{ name: "test_experiment", "owner": "weijie.ou@example.com" ... }'
-u secret_abc123DEF456:
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- variations
- owner
- datasourceId
- trackingKey
- assignmentQueryId
properties:
datasourceId:
type: string
description: 'ID for the [DataSource](#tag/DataSource_model)'
assignmentQueryId:
type: string
description: The ID property of one of the assignment query objects associated with the datasource
trackingKey:
type: string
name:
type: string
description: Name of the experiment
project:
type: string
description: Project ID which the experiment belongs to
hypothesis:
type: string
description: Hypothesis of the experiment
description:
type: string
description: Description of the experiment
tags:
type: array
items:
type: string
metrics:
type: array
items:
type: string
guardrailMetrics:
type: array
items:
type: string
owner:
type: string
description: Email of the person who owns this experiment
archived:
type: boolean
status:
type: string
enum:
- draft
- running
- stopped
autoRefresh:
type: boolean
hashAttribute:
type: string
hashVersion:
type: number
enum:
- 1
- 2
releasedVariationId:
type: string
excludeFromPayload:
type: boolean
variations:
type: array
minItems: 2
items:
type: object
required:
- key
- name
properties:
id:
type: string
key:
type: string
name:
type: string
description:
type: string
screenshots:
type: array
items:
type: object
required:
- path
properties:
path:
type: string
width:
type: number
height:
type: number
description:
type: string
phases:
type: array
items:
type: object
required:
- name
- dateStarted
properties:
name:
type: string
dateStarted:
type: string
format: date
dateEnded:
type: string
format: date
reasonForStopping:
type: string
seed:
type: string
coverage:
type: number
trafficSplit:
type: array
items:
type: object
required:
- variationId
- weight
properties:
variationId:
type: string
weight: