Skip to content

Commit 544d526

Browse files
nthnnnthnn
committed
Complete documentations for Data Analytics alias.
1 parent 5ed7679 commit 544d526

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

‎documentations/src/views/DataAnalytics.vue

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,100 @@
10531053
</li>
10541054
</ul>
10551055

1056+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Alias: Has Anonymous Alias</b>
1057+
<p>Check anonymous ID if it has a username aliasing.</p>
1058+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=alias_anon_has</pre>
1059+
1060+
<p>Payload Structure:</p>
1061+
<ul>
1062+
<li><i>anonymous</i> &mdash; The anonymous ID to be checked. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1063+
</ul>
1064+
1065+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
1066+
<span class="text-warning">"anon_id"</span>: <span class="text-danger">"&lt;anonymous&gt;"</span>
1067+
<span class="text-primary">}</span></pre>
1068+
1069+
<b>Response Data</b>
1070+
<ul>
1071+
<li><i>value</i> &mdash; Returns <i>1</i> if the anonymous ID has a username alias, otherwise <i>0</i>.</li>
1072+
</ul>
1073+
1074+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Alias: Has User Alias</b>
1075+
<p>Check username if it has an anonymous ID aliasing.</p>
1076+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=alias_user_has</pre>
1077+
1078+
<p>Payload Structure:</p>
1079+
<ul>
1080+
<li><i>username</i> &mdash; The username string to be checked. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1081+
</ul>
1082+
1083+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
1084+
<span class="text-warning">"user_id"</span>: <span class="text-danger">"&lt;username&gt;"</span>
1085+
<span class="text-primary">}</span></pre>
1086+
1087+
<b>Response Data</b>
1088+
<ul>
1089+
<li><i>value</i> &mdash; Returns <i>1</i> if the username has an anonymous ID alias, otherwise <i>0</i>.</li>
1090+
</ul>
1091+
1092+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Alias: Set For Anonymous ID</b>
1093+
<p>Set the username for all the associated and matching anonymous ID for all the trackers.</p>
1094+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=alias_for_anon</pre>
1095+
1096+
<p>Payload Structure:</p>
1097+
<ul>
1098+
<li><i>anonymous</i> &mdash; The anonymous ID where the username alias will be placed. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1099+
<li><i>username</i> &mdash; The username string for all the matching anonymous ID. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1100+
</ul>
1101+
1102+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
1103+
<span class="text-warning">"anon_id"</span>: <span class="text-danger">"&lt;anonymous&gt;"</span>,
1104+
<span class="text-warning">"user_id"</span>: <span class="text-danger">"&lt;username&gt;"</span>
1105+
<span class="text-primary">}</span></pre>
1106+
1107+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Alias: Set For User ID</b>
1108+
<p>Set the anonymous ID for all the associated and matching username for all the trackers.</p>
1109+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=alias_for_user</pre>
1110+
1111+
<p>Payload Structure:</p>
1112+
<ul>
1113+
<li><i>username</i> &mdash; The username where the anonymous ID alias will be placed. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1114+
<li><i>anonymous</i> &mdash; The anonymous ID for all the matching username. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
1115+
</ul>
1116+
1117+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
1118+
<span class="text-warning">"user_id"</span>: <span class="text-danger">"&lt;username&gt;"</span>,
1119+
<span class="text-warning">"anon_id"</span>: <span class="text-danger">"&lt;anonymous&gt;"</span>
1120+
<span class="text-primary">}</span></pre>
1121+
1122+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Alias: Fetch All</b>
1123+
<p>Fetch all the alias matches for each anonymous ID and username string.</p>
1124+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=alias_fetch_all</pre>
1125+
1126+
<b>Example Payload</b>
1127+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{}</span></pre>
1128+
1129+
<b>Response Data</b>
1130+
<ul>
1131+
<li>
1132+
<i>value</i> &mdash; This key will contain a 2D array of alias that contains the pairs of each anonymous IDs and usernames.
1133+
<table class="table table-hover">
1134+
<tr>
1135+
<th>Array Index</th>
1136+
<th>Index Content</th>
1137+
</tr>
1138+
<tr>
1139+
<td>0</td>
1140+
<td>Username string of the pair.</td>
1141+
</tr>
1142+
<tr>
1143+
<td>1</td>
1144+
<td>Anonymous ID string of the pair.</td>
1145+
</tr>
1146+
</table>
1147+
</li>
1148+
</ul>
1149+
10561150
<div class="row">
10571151
<div class="col-6">
10581152
<RouterLink to="/sms-verification" class="btn btn-primary">

0 commit comments

Comments
 (0)