-
-
Notifications
You must be signed in to change notification settings - Fork 693
Expand file tree
/
Copy pathexperiments.ts
More file actions
139 lines (126 loc) · 3.55 KB
/
Copy pathexperiments.ts
File metadata and controls
139 lines (126 loc) · 3.55 KB
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
import { authedFetch } from "../../utils";
import type {
FeatureFlagConditionSet,
FeatureFlagPayloadValue,
FeatureFlagRuntime,
FeatureFlagType,
FeatureFlagVariant,
} from "./featureFlags";
import { CommonApiParams, toQueryParams } from "./types";
export type ExperimentStatus = "draft" | "running" | "paused" | "completed";
export type ExperimentFeatureFlag = {
flagId: number;
siteId: number;
key: string;
description: string | null;
enabled: boolean;
runtime: FeatureFlagRuntime;
flagType: FeatureFlagType;
payload?: FeatureFlagPayloadValue | null;
variants: FeatureFlagVariant[];
rolloutPercentage: number;
conditionSets: FeatureFlagConditionSet[];
version: number;
createdAt: string;
updatedAt: string;
};
export type ExperimentGoal = {
goalId: number;
siteId: number;
name: string | null;
goalType: "path" | "event";
config: {
pathPattern?: string;
eventName?: string;
eventPropertyKey?: string;
eventPropertyValue?: string | number | boolean;
propertyFilters?: Array<{
key: string;
value: string | number | boolean;
}>;
};
createdAt: string;
};
export type Experiment = {
experimentId: number;
siteId: number;
featureFlagId: number;
primaryGoalId: number | null;
name: string;
description: string | null;
hypothesis: string | null;
status: ExperimentStatus;
winningVariant: string | null;
startedAt: string | null;
endedAt: string | null;
createdAt: string;
updatedAt: string;
featureFlag: ExperimentFeatureFlag;
primaryGoal: ExperimentGoal | null;
};
export type ExperimentPayload = {
name: string;
description?: string | null;
hypothesis?: string | null;
featureFlagId: number;
primaryGoalId?: number | null;
status: ExperimentStatus;
winningVariant?: string | null;
};
export type ExperimentUpdatePayload = Partial<ExperimentPayload>;
export type ExperimentVariantResult = {
variant: string;
sessions: number;
exposures: number;
conversions: number;
conversionRate: number;
lift: number | null;
isControl: boolean;
};
export type ExperimentResults = {
experiment: Experiment;
variants: ExperimentVariantResult[];
totalExposureSessions: number;
totalConversions: number;
hasGoal: boolean;
measurement: "exposure" | "assignment";
};
export async function fetchExperiments(site: string | number): Promise<Experiment[]> {
const response = await authedFetch<{ data: Experiment[] }>(`/sites/${site}/experiments`);
return response.data;
}
export async function createExperiment(
site: string | number,
payload: ExperimentPayload
): Promise<{ success: boolean; data: Experiment }> {
return authedFetch(`/sites/${site}/experiments`, undefined, {
method: "POST",
data: payload,
});
}
export async function updateExperiment(
site: string | number,
experimentId: number,
payload: ExperimentUpdatePayload
): Promise<{ success: boolean; data: Experiment }> {
return authedFetch(`/sites/${site}/experiments/${experimentId}`, undefined, {
method: "PUT",
data: payload,
});
}
export async function deleteExperiment(site: string | number, experimentId: number): Promise<{ success: boolean }> {
return authedFetch(`/sites/${site}/experiments/${experimentId}`, undefined, {
method: "DELETE",
});
}
export async function fetchExperimentResults(
site: string | number,
experimentId: number,
params: CommonApiParams
): Promise<ExperimentResults> {
const response = await authedFetch<{ data: ExperimentResults }>(
`/sites/${site}/experiments/${experimentId}/results`,
toQueryParams(params)
);
return response.data;
}