Skip to content

Commit 9484e63

Browse files
nthnnnthnn
committed
Complete Data Analytics tracker documentations.
1 parent 6cf7b1a commit 9484e63

File tree

1 file changed

+246
-1
lines changed

1 file changed

+246
-1
lines changed

‎documentations/src/views/DataAnalytics.vue

Lines changed: 246 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138

139139
<p>Payload Structure:</p>
140140
<ul>
141-
<li><i>anonymous</i> &mdash; The anonymous string of the tracker to be deleted. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
141+
<li><i>anonymous</i> &mdash; The anonymous string of the tracker to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
142142
</ul>
143143

144144
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
@@ -387,6 +387,251 @@
387387
<span class="text-warning">"event"</span>: <span class="text-danger">"&lt;tag&gt;"</span>
388388
<span class="text-primary">}</span></pre>
389389

390+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Delete by Timestamp</b>
391+
<p>Delete tracker record(s) by a specified timestamp.</p>
392+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_delete_by_timestamp</pre>
393+
394+
<p>Payload Structure:</p>
395+
<ul>
396+
<li><i>id</i> &mdash; The identification string of the tracker to be deleted. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
397+
<li><i>datetime</i> &mdash; Timestamp of the tracker on the record to be deleted. (Should be in format Y-m-d H:i:s)</li>
398+
</ul>
399+
400+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
401+
<span class="text-warning">"tracker"</span>: <span class="text-danger">"&lt;id&gt;"</span>,
402+
<span class="text-warning">"timestamp"</span>: <span class="text-danger">"&lt;datetime&gt;"</span>
403+
<span class="text-primary">}</span></pre>
404+
405+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Get by Anonymous ID</b>
406+
<p>Fetches an tracker by a specified anonymous ID.</p>
407+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_get_by_anon_id</pre>
408+
409+
<p>Payload Structure:</p>
410+
<ul>
411+
<li><i>anonymous</i> &mdash; The anonymous string of the tracker to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
412+
</ul>
413+
414+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
415+
<span class="text-warning">"anon_id"</span>: <span class="text-danger">"&lt;anonymous&gt;"</span>
416+
<span class="text-primary">}</span></pre>
417+
418+
<b>Response Data</b>
419+
<ul>
420+
<li>
421+
<i>value</i> &mdash; This key will contain a 2D array of trackers. The array of tracker's order of items is as the following table below:
422+
<table class="table table-hover">
423+
<tr>
424+
<th>Array Index</th>
425+
<th>Index Content</th>
426+
</tr>
427+
<tr>
428+
<td>0</td>
429+
<td>Tracker identification string</td>
430+
</tr>
431+
<tr>
432+
<td>1</td>
433+
<td>Username string</td>
434+
</tr>
435+
<tr>
436+
<td>2</td>
437+
<td>Event name of the fetched tracker</td>
438+
</tr>
439+
<tr>
440+
<td>3</td>
441+
<td>Timestamp of the identification tracker with the format &quot;<i>YYYY-mm-dd hh:mm:ss</i>&quot;</td>
442+
</tr>
443+
<tr>
444+
<td>4</td>
445+
<td>The data payload in JSON form.</td>
446+
</tr>
447+
</table>
448+
</li>
449+
</ul>
450+
451+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Get by User ID</b>
452+
<p>Fetches an tracker by a specified username ID.</p>
453+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_get_by_user_id</pre>
454+
455+
<p>Payload Structure:</p>
456+
<ul>
457+
<li><i>username</i> &mdash; The username string of the tracker to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
458+
</ul>
459+
460+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
461+
<span class="text-warning">"user_id"</span>: <span class="text-danger">"&lt;username&gt;"</span>
462+
<span class="text-primary">}</span></pre>
463+
464+
<b>Response Data</b>
465+
<ul>
466+
<li>
467+
<i>value</i> &mdash; This key will contain a 2D array of trackers. The array of tracker's order of items is as the following table below:
468+
<table class="table table-hover">
469+
<tr>
470+
<th>Array Index</th>
471+
<th>Index Content</th>
472+
</tr>
473+
<tr>
474+
<td>0</td>
475+
<td>Tracker identification string</td>
476+
</tr>
477+
<tr>
478+
<td>1</td>
479+
<td>Anonymous ID string</td>
480+
</tr>
481+
<tr>
482+
<td>2</td>
483+
<td>Event name of the fetched tracker</td>
484+
</tr>
485+
<tr>
486+
<td>3</td>
487+
<td>Timestamp of the identification tracker with the format &quot;<i>YYYY-mm-dd hh:mm:ss</i>&quot;</td>
488+
</tr>
489+
<tr>
490+
<td>4</td>
491+
<td>The data payload in JSON form.</td>
492+
</tr>
493+
</table>
494+
</li>
495+
</ul>
496+
497+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Get by Event</b>
498+
<p>Fetches an tracker by a specified event tag.</p>
499+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_get_by_event</pre>
500+
501+
<p>Payload Structure:</p>
502+
<ul>
503+
<li><i>username</i> &mdash; The username string of the tracker to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
504+
<li><i>tag</i> &mdash; The event name string of tracker to be fetched. (Should be a-z, A-Z, 0-9, and greater than or equals to 6 characters)</li>
505+
</ul>
506+
507+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
508+
<span class="text-warning">"user_id"</span>: <span class="text-danger">"&lt;username&gt;"</span>,
509+
<span class="text-warning">"event"</span>: <span class="text-danger">"&lt;tag&gt;"</span>
510+
<span class="text-primary">}</span></pre>
511+
512+
<b>Response Data</b>
513+
<ul>
514+
<li>
515+
<i>value</i> &mdash; This key will contain a 2D array of trackers. The array of tracker's order of items is as the following table below:
516+
<table class="table table-hover">
517+
<tr>
518+
<th>Array Index</th>
519+
<th>Index Content</th>
520+
</tr>
521+
<tr>
522+
<td>0</td>
523+
<td>Tracker identification string</td>
524+
</tr>
525+
<tr>
526+
<td>1</td>
527+
<td>Username string</td>
528+
</tr>
529+
<tr>
530+
<td>2</td>
531+
<td>Anonymous ID string</td>
532+
</tr>
533+
<tr>
534+
<td>3</td>
535+
<td>Timestamp of the identification tracker with the format &quot;<i>YYYY-mm-dd hh:mm:ss</i>&quot;</td>
536+
</tr>
537+
<tr>
538+
<td>4</td>
539+
<td>The data payload in JSON form.</td>
540+
</tr>
541+
</table>
542+
</li>
543+
</ul>
544+
545+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Get by Timestamp</b>
546+
<p>Fetches an tracker by a specified timestamp.</p>
547+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_get_by_timestamp</pre>
548+
549+
<p>Payload Structure:</p>
550+
<ul>
551+
<li><i>datetime</i> &mdash; Timestamp of the identification on the record. (Should be in format Y-m-d H:i:s)</li>
552+
</ul>
553+
554+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
555+
<span class="text-warning">"timestamp"</span>: <span class="text-danger">"&lt;datetime&gt;"</span>
556+
<span class="text-primary">}</span></pre>
557+
558+
<b>Response Data</b>
559+
<ul>
560+
<li>
561+
<i>value</i> &mdash; This key will contain a 2D array of trackers. The array of tracker's order of items is as the following table below:
562+
<table class="table table-hover">
563+
<tr>
564+
<th>Array Index</th>
565+
<th>Index Content</th>
566+
</tr>
567+
<tr>
568+
<td>0</td>
569+
<td>Tracker identification string</td>
570+
</tr>
571+
<tr>
572+
<td>1</td>
573+
<td>Anonymous ID string</td>
574+
</tr>
575+
<tr>
576+
<td>2</td>
577+
<td>Username string</td>
578+
</tr>
579+
<tr>
580+
<td>3</td>
581+
<td>Event name of the fetched tracker</td>
582+
</tr>
583+
<tr>
584+
<td>4</td>
585+
<td>The data payload in JSON form.</td>
586+
</tr>
587+
</table>
588+
</li>
589+
</ul>
590+
591+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Track: Fetch All</b>
592+
<p>Fetches all recorded trackers.</p>
593+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=track_fetch_all</pre>
594+
595+
<b>Example Payload</b>
596+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{}</span></pre>
597+
598+
<b>Response Data</b>
599+
<ul>
600+
<li>
601+
<i>value</i> &mdash; This key will contain a 2D array of all trackers recorded. The array of trackers' order of items is as the following table below:
602+
<table class="table table-hover">
603+
<tr>
604+
<th>Array Index</th>
605+
<th>Index Content</th>
606+
</tr>
607+
<tr>
608+
<td>0</td>
609+
<td>Tracker identification string</td>
610+
</tr>
611+
<tr>
612+
<td>1</td>
613+
<td>Anonymous ID string</td>
614+
</tr>
615+
<tr>
616+
<td>2</td>
617+
<td>Username string</td>
618+
</tr>
619+
<tr>
620+
<td>3</td>
621+
<td>Event name of the tracker</td>
622+
</tr>
623+
<tr>
624+
<td>4</td>
625+
<td>Timestamp of the identification tracker with the format &quot;<i>YYYY-mm-dd hh:mm:ss</i>&quot;</td>
626+
</tr>
627+
<tr>
628+
<td>5</td>
629+
<td>The data payload in JSON form.</td>
630+
</tr>
631+
</table>
632+
</li>
633+
</ul>
634+
390635
<div class="row">
391636
<div class="col-6">
392637
<RouterLink to="/sms-verification" class="btn btn-primary">

0 commit comments

Comments
 (0)