Skip to content

Commit c6164f9

Browse files
karlenDimlakarlenDimla
committed
Add pixel definition for Opt-out submission success rate
1 parent 4409d25 commit c6164f9

File tree

1 file changed

+133
-0
lines changed

1 file changed

+133
-0
lines changed

‎PixelDefinitions/pixels/personal_information_removal.json5‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
{
2+
"pir_optout_process_submit-success": {
3+
"description": "Fired when an opt-out submission succeeds.",
4+
"owners": ["karlenDimla", "landomen"],
5+
"triggers": ["other"],
6+
"suffixes": ["form_factor"],
7+
"parameters": [
8+
"appVersion",
9+
{
10+
"key": "data_broker",
11+
"description": "The URL of the data broker that this opt-out attempt targets",
12+
"type": "string"
13+
},
14+
{
15+
"key": "parent",
16+
"description": "The parent data broker of the one this opt-out attempt targets",
17+
"type": "string"
18+
},
19+
{
20+
"key": "attempt_id",
21+
"description": "Client-generated ID of the opt-out attempt",
22+
"type": "string"
23+
},
24+
{
25+
"key": "duration",
26+
"description": "Total duration of the opt-out attempt in milliseconds",
27+
"type": "string"
28+
},
29+
{
30+
"key": "tries",
31+
"description": "The number of tries it took to submit successfully",
32+
"type": "string"
33+
},
34+
{
35+
"key": "pattern",
36+
"description": "Email pattern used during submission, when available",
37+
"type": "string"
38+
},
39+
{
40+
"key": "vpn_connection_state",
41+
"description": "Reported VPN connection state when the submission succeeded",
42+
"type": "string"
43+
},
44+
{
45+
"key": "vpn_bypass",
46+
"description": "VPN bypass status when the submission succeeded",
47+
"type": "string",
48+
"enum": ["on", "off", "unsupported"]
49+
}
50+
]
51+
},
52+
"pir_optout_process_failure": {
53+
"description": "Fired when an opt-out attempt fails.",
54+
"owners": ["karlenDimla", "landomen"],
55+
"triggers": ["other"],
56+
"suffixes": ["form_factor"],
57+
"parameters": [
58+
"appVersion",
59+
{
60+
"key": "data_broker",
61+
"description": "The URL of the data broker that this opt-out attempt targets",
62+
"type": "string"
63+
},
64+
{
65+
"key": "parent",
66+
"description": "The parent data broker of the one this opt-out attempt targets",
67+
"type": "string"
68+
},
69+
{
70+
"key": "broker_version",
71+
"description": "The version of the broker JSON file",
72+
"type": "string"
73+
},
74+
{
75+
"key": "attempt_id",
76+
"description": "Client-generated ID of the opt-out attempt",
77+
"type": "string"
78+
},
79+
{
80+
"key": "duration",
81+
"description": "Total duration of the opt-out attempt in milliseconds",
82+
"type": "string"
83+
},
84+
{
85+
"key": "stage",
86+
"description": "The stage where the failure occurred",
87+
"type": "string"
88+
},
89+
{
90+
"key": "tries",
91+
"description": "The number of tries recorded when the failure happened",
92+
"type": "string"
93+
},
94+
{
95+
"key": "pattern",
96+
"description": "Email pattern used during the attempt, when available",
97+
"type": "string"
98+
},
99+
{
100+
"key": "action_id",
101+
"description": "Predefined identifier of the broker action that failed",
102+
"type": "string"
103+
},
104+
{
105+
"key": "action_type",
106+
"description": "Type of action that failed",
107+
"type": "string",
108+
"enum": [
109+
"extract",
110+
"navigate",
111+
"fillForm",
112+
"click",
113+
"expectation",
114+
"emailConfirmation",
115+
"getCaptchaInfo",
116+
"solveCaptcha",
117+
"condition"
118+
]
119+
},
120+
{
121+
"key": "vpn_connection_state",
122+
"description": "Reported VPN connection state when the failure happened",
123+
"type": "string"
124+
},
125+
{
126+
"key": "vpn_bypass",
127+
"description": "VPN bypass status when the failure happened",
128+
"type": "string",
129+
"enum": ["on", "off", "unsupported"]
130+
}
131+
]
132+
}
133+
}

0 commit comments

Comments
 (0)