Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 5.1
edited by rayaan@one-count_com
on 2023/12/12 07:43
Change comment: There is no comment for this version
To version 8.1
edited by rayaan@one-count_com
on 2024/01/10 14:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +System Setup Detail and Technical Information
Content
... ... @@ -59,6 +59,11 @@
59 59  11. Create Engagements
60 60  11. Update Engagements
61 61  11. Add users data to Engagement
62 +1. Segments\\
63 +11. Get all Segments
64 +11. Get specific segment by segment id
65 +11. Add users to segment
66 +11. Get all segment ids for a user
62 62  
63 63  \\
64 64  
... ... @@ -115,7 +115,7 @@
115 115  (% class="western" %)
116 116  API will output the response in a JSON format discussed below.
117 117  
118 -{{code language="yml" theme="RDark" title="Response" collapse="true"}}
123 +{{code language="yml" theme="RDark" title="Response"}}
119 119  {
120 120   "result": {
121 121   "success": "1",
... ... @@ -335,7 +335,7 @@
335 335  
336 336  (% style="color: rgb(107,107,107);" %)Request
337 337  
338 -{{code language="php" theme="RDark" title="Get All Users Request" collapse="true"}}
343 +{{code language="php" theme="RDark" title="Get All Users Request"}}
339 339  <?php
340 340  
341 341  $curl = curl_init();
... ... @@ -364,7 +364,7 @@
364 364  
365 365  \\
366 366  
367 -(% style="color: rgb(107,107,107);" %)Response  200 OK
372 +(% style="color: rgb(107,107,107);" %)Response  200 OK
368 368  
369 369  {{code language="yml" theme="RDark" title="Get All Users Response" collapse="true"}}
370 370  {
... ... @@ -875,7 +875,7 @@
875 875  
876 876  (% style="color: rgb(107,107,107);" %)Request
877 877  
878 -{{code language="php" theme="RDark" title="Get specific User Request" collapse="true"}}
883 +{{code language="php" theme="RDark" title="Get specific User Request"}}
879 879  <?php
880 880  
881 881  $curl = curl_init();
... ... @@ -902,7 +902,7 @@
902 902  
903 903  \\
904 904  
905 -(% style="color: rgb(107,107,107);" %)Response  200 OK
910 +(% style="color: rgb(107,107,107);" %)Response  200 OK
906 906  
907 907  {{code language="yml" theme="RDark" title="Get specific user Response" collapse="true"}}
908 908  {
... ... @@ -973,7 +973,7 @@
973 973  
974 974  ----
975 975  
976 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
981 +{{code language="yml" theme="RDark" title="Body"}}
977 977  {"e":"rayaan@one-count.com","p":"12345"}
978 978  {{/code}}
979 979  
... ... @@ -983,7 +983,7 @@
983 983  
984 984  (% style="color: rgb(107,107,107);" %)Request
985 985  
986 -{{code language="php" theme="RDark" title="User login Request" collapse="true"}}
991 +{{code language="php" theme="RDark" title="User login Request"}}
987 987  <?php
988 988  
989 989  $curl = curl_init();
... ... @@ -1011,7 +1011,7 @@
1011 1011  
1012 1012  \\
1013 1013  
1014 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1019 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1015 1015  
1016 1016  {{code language="yml" theme="RDark" title="Login user Response" collapse="true"}}
1017 1017  {
... ... @@ -1058,7 +1058,7 @@
1058 1058  
1059 1059  (% style="color: rgb(107,107,107);" %)Request
1060 1060  
1061 -{{code language="php" theme="RDark" title="Lookup user Request" collapse="true"}}
1066 +{{code language="php" theme="RDark" title="Lookup user Request"}}
1062 1062  <?php
1063 1063  
1064 1064  $curl = curl_init();
... ... @@ -1085,7 +1085,7 @@
1085 1085  
1086 1086  \\
1087 1087  
1088 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1093 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1089 1089  
1090 1090  {{code language="yml" theme="RDark" title="Lookup user Response" collapse="true"}}
1091 1091  {
... ... @@ -1246,7 +1246,7 @@
1246 1246  
1247 1247  ----
1248 1248  
1249 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
1254 +{{code language="yml" theme="RDark" title="Body"}}
1250 1250  {"Users":{"PartnerId":1,"Demo":{"1":"testApirayaan7@onecount.net","4":"Rayaan","5":"Ahmed"}},"DedupeColumns":"1","Transactions":[]}
1251 1251  {{/code}}
1252 1252  
... ... @@ -1256,7 +1256,7 @@
1256 1256  
1257 1257  (% style="color: rgb(107,107,107);" %)Request
1258 1258  
1259 -{{code language="php" theme="RDark" title="Create User Request" collapse="true"}}
1264 +{{code language="php" theme="RDark" title="Create User Request"}}
1260 1260  <?php
1261 1261  
1262 1262  $curl = curl_init();
... ... @@ -1284,7 +1284,7 @@
1284 1284  
1285 1285  \\
1286 1286  
1287 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1292 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1288 1288  
1289 1289  {{code language="yml" theme="RDark" title="Create user Response" collapse="true"}}
1290 1290  {
... ... @@ -1410,7 +1410,7 @@
1410 1410  
1411 1411  ----
1412 1412  
1413 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
1418 +{{code language="yml" theme="RDark" title="Body"}}
1414 1414  {"Users":{"Demo":{"6":"title1"}}}
1415 1415  {{/code}}
1416 1416  
... ... @@ -1420,7 +1420,7 @@
1420 1420  
1421 1421  (% style="color: rgb(107,107,107);" %)Request
1422 1422  
1423 -{{code language="php" theme="RDark" title="Update User Request" collapse="true"}}
1428 +{{code language="php" theme="RDark" title="Update User Request"}}
1424 1424  <?php
1425 1425  
1426 1426  $curl = curl_init();
... ... @@ -1450,7 +1450,7 @@
1450 1450  
1451 1451  \\
1452 1452  
1453 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1458 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1454 1454  
1455 1455  {{code language="yml" theme="RDark" title="Update user Response" collapse="true"}}
1456 1456  {
... ... @@ -1664,7 +1664,7 @@
1664 1664  
1665 1665  (% style="color: rgb(107,107,107);" %)Request
1666 1666  
1667 -{{code language="php" theme="RDark" title="Get All Questions Request" collapse="true"}}
1672 +{{code language="php" theme="RDark" title="Get All Questions Request"}}
1668 1668  <?php
1669 1669  
1670 1670  $curl = curl_init();
... ... @@ -1694,7 +1694,7 @@
1694 1694  
1695 1695  \\
1696 1696  
1697 -(% style="color: rgb(107,107,107);" %)Response  200 OK
1702 +(% style="color: rgb(107,107,107);" %)Response  200 OK
1698 1698  
1699 1699  {{code language="yml" theme="RDark" title="Get All Questions Response" collapse="true"}}
1700 1700  {
... ... @@ -3805,7 +3805,7 @@
3805 3805  
3806 3806  (% style="color: rgb(107,107,107);" %)Request
3807 3807  
3808 -{{code language="php" theme="RDark" title="Get specific Question Request" collapse="true"}}
3813 +{{code language="php" theme="RDark" title="Get specific Question Request"}}
3809 3809  <?php
3810 3810  
3811 3811  $curl = curl_init();
... ... @@ -3832,7 +3832,7 @@
3832 3832  
3833 3833  \\
3834 3834  
3835 -(% style="color: rgb(107,107,107);" %)Response  200 OK
3840 +(% style="color: rgb(107,107,107);" %)Response  200 OK
3836 3836  
3837 3837  {{code language="yml" theme="RDark" title="Get specific question Response" collapse="true"}}
3838 3838  {
... ... @@ -3884,7 +3884,7 @@
3884 3884  
3885 3885  (% style="color: rgb(107,107,107);" %)Request
3886 3886  
3887 -{{code language="php" theme="RDark" title="Lookup question by text Request" collapse="true"}}
3892 +{{code language="php" theme="RDark" title="Lookup question by text Request"}}
3888 3888  <?php
3889 3889  
3890 3890  $curl = curl_init();
... ... @@ -3911,7 +3911,7 @@
3911 3911  
3912 3912  \\
3913 3913  
3914 -(% style="color: rgb(107,107,107);" %)Response  200 OK
3919 +(% style="color: rgb(107,107,107);" %)Response  200 OK
3915 3915  
3916 3916  {{code language="yml" theme="RDark" title="Lookup question by title Response" collapse="true"}}
3917 3917  {
... ... @@ -5330,7 +5330,7 @@
5330 5330  
5331 5331  (% style="color: rgb(107,107,107);" %)Request
5332 5332  
5333 -{{code language="php" theme="RDark" title="Lookup question by Type Request" collapse="true"}}
5338 +{{code language="php" theme="RDark" title="Lookup question by Type Request"}}
5334 5334  <?php
5335 5335  
5336 5336  $curl = curl_init();
... ... @@ -5357,7 +5357,7 @@
5357 5357  
5358 5358  \\
5359 5359  
5360 -(% style="color: rgb(107,107,107);" %)Response  200 OK
5365 +(% style="color: rgb(107,107,107);" %)Response  200 OK
5361 5361  
5362 5362  {{code language="yml" theme="RDark" title="Lookup question by type Response" collapse="true"}}
5363 5363  {
... ... @@ -8027,7 +8027,7 @@
8027 8027  
8028 8028  ----
8029 8029  
8030 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8035 +{{code language="yml" theme="RDark" title="Body"}}
8031 8031  {"Text":"Test from API 3","Type":0,"Alias":"Test from API 3"}
8032 8032  {{/code}}
8033 8033  
... ... @@ -8037,7 +8037,7 @@
8037 8037  
8038 8038  (% style="color: rgb(107,107,107);" %)Request
8039 8039  
8040 -{{code language="php" theme="RDark" title="Create Question Request" collapse="true"}}
8045 +{{code language="php" theme="RDark" title="Create Question Request"}}
8041 8041  <?php
8042 8042  
8043 8043  $curl = curl_init();
... ... @@ -8065,7 +8065,7 @@
8065 8065  
8066 8066  \\
8067 8067  
8068 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8073 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8069 8069  
8070 8070  {{code language="yml" theme="RDark" title="Create question Response" collapse="true"}}
8071 8071  {
... ... @@ -8105,7 +8105,7 @@
8105 8105  
8106 8106  ----
8107 8107  
8108 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8113 +{{code language="yml" theme="RDark" title="Body"}}
8109 8109  {"Text":"Test from API 6","Type":4,"Alias":"Test from API 6", "Choices":[{"Text":"test 1","Value":"test 1"},{"Text":"test 2","Value":"test 2"}]}
8110 8110  {{/code}}
8111 8111  
... ... @@ -8115,7 +8115,7 @@
8115 8115  
8116 8116  (% style="color: rgb(107,107,107);" %)Request
8117 8117  
8118 -{{code language="php" theme="RDark" title="Create Question Request" collapse="true"}}
8123 +{{code language="php" theme="RDark" title="Create Question Request"}}
8119 8119  <?php
8120 8120  
8121 8121  $curl = curl_init();
... ... @@ -8143,7 +8143,7 @@
8143 8143  
8144 8144  \\
8145 8145  
8146 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8151 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8147 8147  
8148 8148  {{code language="yml" theme="RDark" title="Create question Response" collapse="true"}}
8149 8149  {
... ... @@ -8183,7 +8183,7 @@
8183 8183  
8184 8184  ----
8185 8185  
8186 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8191 +{{code language="yml" theme="RDark" title="Body"}}
8187 8187  {"Text":"Test from API 6 changed","Type":4,"Alias":"Test from API 6 changed", "Choices":[{"Text":"test 1","Value":"test 1"},{"Text":"test 2","Value":"test 2"}]}
8188 8188  {{/code}}
8189 8189  
... ... @@ -8193,7 +8193,7 @@
8193 8193  
8194 8194  (% style="color: rgb(107,107,107);" %)Request
8195 8195  
8196 -{{code language="php" theme="RDark" title="Update Question Request" collapse="true"}}
8201 +{{code language="php" theme="RDark" title="Update Question Request"}}
8197 8197  <?php
8198 8198  
8199 8199  $curl = curl_init();
... ... @@ -8223,7 +8223,7 @@
8223 8223  
8224 8224  \\
8225 8225  
8226 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8231 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8227 8227  
8228 8228  {{code language="yml" theme="RDark" title="Update Question Response" collapse="true"}}
8229 8229  {
... ... @@ -8378,7 +8378,7 @@
8378 8378  
8379 8379  (% style="color: rgb(107,107,107);" %)Request
8380 8380  
8381 -{{code language="php" theme="RDark" title="Get All Products Request" collapse="true"}}
8386 +{{code language="php" theme="RDark" title="Get All Products Request"}}
8382 8382  <?php
8383 8383  
8384 8384  $curl = curl_init();
... ... @@ -8407,7 +8407,7 @@
8407 8407  
8408 8408  \\
8409 8409  
8410 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8415 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8411 8411  
8412 8412  {{code language="yml" theme="RDark" title="Get All Products Response" collapse="true"}}
8413 8413   {
... ... @@ -8666,7 +8666,7 @@
8666 8666  
8667 8667  (% style="color: rgb(107,107,107);" %)Request
8668 8668  
8669 -{{code language="php" theme="RDark" title="Get specific Product Request" collapse="true"}}
8674 +{{code language="php" theme="RDark" title="Get specific Product Request"}}
8670 8670   <?php
8671 8671  
8672 8672  $curl = curl_init();
... ... @@ -8693,7 +8693,7 @@
8693 8693  
8694 8694  \\
8695 8695  
8696 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8701 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8697 8697  
8698 8698  {{code language="yml" theme="RDark" title="Get specific Product Response" collapse="true"}}
8699 8699   {
... ... @@ -8756,7 +8756,7 @@
8756 8756  
8757 8757  (% style="color: rgb(107,107,107);" %)Request
8758 8758  
8759 -{{code language="php" theme="RDark" title="Lookup Product Request" collapse="true"}}
8764 +{{code language="php" theme="RDark" title="Lookup Product Request"}}
8760 8760   <?php
8761 8761  
8762 8762  $curl = curl_init();
... ... @@ -8783,7 +8783,7 @@
8783 8783  
8784 8784  \\
8785 8785  
8786 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8791 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8787 8787  
8788 8788  {{code language="yml" theme="RDark" title="Lookup Product Response" collapse="true"}}
8789 8789   {
... ... @@ -8834,7 +8834,7 @@
8834 8834  
8835 8835  ----
8836 8836  
8837 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8842 +{{code language="yml" theme="RDark" title="Body"}}
8838 8838  {"Title":"Test API package creation 2","Description": "Test API package creation 2","Terms":{"Name":"Test term for API 2"},"PrimaryFormId":0}
8839 8839  {{/code}}
8840 8840  
... ... @@ -8844,7 +8844,7 @@
8844 8844  
8845 8845  (% style="color: rgb(107,107,107);" %)Request
8846 8846  
8847 -{{code language="php" theme="RDark" title="Create Product Request" collapse="true"}}
8852 +{{code language="php" theme="RDark" title="Create Product Request"}}
8848 8848   <?php
8849 8849  
8850 8850  $curl = curl_init();
... ... @@ -8872,7 +8872,7 @@
8872 8872  
8873 8873  \\
8874 8874  
8875 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8880 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8876 8876  
8877 8877  {{code language="yml" theme="RDark" title="Create Product Response" collapse="true"}}
8878 8878   {
... ... @@ -8912,7 +8912,7 @@
8912 8912  
8913 8913  ----
8914 8914  
8915 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8920 +{{code language="yml" theme="RDark" title="Body"}}
8916 8916  {"Title":"Test API package 23","Description": "Test API package 23","PrimaryFormId":0}
8917 8917  {{/code}}
8918 8918  
... ... @@ -8922,7 +8922,7 @@
8922 8922  
8923 8923  (% style="color: rgb(107,107,107);" %)Request
8924 8924  
8925 -{{code language="php" theme="RDark" title="Update Product Request" collapse="true"}}
8930 +{{code language="php" theme="RDark" title="Update Product Request"}}
8926 8926  <?php
8927 8927  
8928 8928  $curl = curl_init();
... ... @@ -8951,7 +8951,7 @@
8951 8951  
8952 8952  \\
8953 8953  
8954 -(% style="color: rgb(107,107,107);" %)Response  200 OK
8959 +(% style="color: rgb(107,107,107);" %)Response  200 OK
8955 8955  
8956 8956  {{code language="yml" theme="RDark" title="Update Product Response" collapse="true"}}
8957 8957   {
... ... @@ -8993,7 +8993,7 @@
8993 8993  
8994 8994  ----
8995 8995  
8996 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
9001 +{{code language="yml" theme="RDark" title="Body"}}
8997 8997  {"ProductID":"599","ResourceID":"903"}
8998 8998  {{/code}}
8999 8999  
... ... @@ -9003,7 +9003,7 @@
9003 9003  
9004 9004  (% style="color: rgb(107,107,107);" %)Request
9005 9005  
9006 -{{code language="php" theme="RDark" title="Attach Resource to Product Request" collapse="true"}}
9011 +{{code language="php" theme="RDark" title="Attach Resource to Product Request"}}
9007 9007   <?php
9008 9008  
9009 9009  $curl = curl_init();
... ... @@ -9031,7 +9031,7 @@
9031 9031  
9032 9032  \\
9033 9033  
9034 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9039 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9035 9035  
9036 9036  {{code language="yml" theme="RDark" title="Create Product Response" collapse="true"}}
9037 9037   {
... ... @@ -9144,7 +9144,7 @@
9144 9144  
9145 9145  (% style="color: rgb(107,107,107);" %)Request
9146 9146  
9147 -{{code language="php" theme="RDark" title="Get All Terms Request" collapse="true"}}
9152 +{{code language="php" theme="RDark" title="Get All Terms Request"}}
9148 9148   <?php
9149 9149  
9150 9150  $curl = curl_init();
... ... @@ -9171,7 +9171,7 @@
9171 9171  
9172 9172  \\
9173 9173  
9174 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9179 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9175 9175  
9176 9176  {{code language="yml" theme="RDark" title="Get All Terms Response" collapse="true"}}
9177 9177   {
... ... @@ -9327,7 +9327,7 @@
9327 9327  
9328 9328  (% style="color: rgb(107,107,107);" %)Request
9329 9329  
9330 -{{code language="php" theme="RDark" title="Get specific Term Request" collapse="true"}}
9335 +{{code language="php" theme="RDark" title="Get specific Term Request"}}
9331 9331   <?php
9332 9332  
9333 9333  $curl = curl_init();
... ... @@ -9354,7 +9354,7 @@
9354 9354  
9355 9355  \\
9356 9356  
9357 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9362 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9358 9358  
9359 9359  {{code language="yml" theme="RDark" title="Get specific Term Response" collapse="true"}}
9360 9360   {
... ... @@ -9408,7 +9408,7 @@
9408 9408  
9409 9409  (% style="color: rgb(107,107,107);" %)Request
9410 9410  
9411 -{{code language="php" theme="RDark" title="Lookup Term Request" collapse="true"}}
9416 +{{code language="php" theme="RDark" title="Lookup Term Request"}}
9412 9412   <?php
9413 9413  
9414 9414  $curl = curl_init();
... ... @@ -9435,7 +9435,7 @@
9435 9435  
9436 9436  \\
9437 9437  
9438 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9443 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9439 9439  
9440 9440  {{code language="yml" theme="RDark" title="Lookup Term Response" collapse="true"}}
9441 9441  {
... ... @@ -9481,7 +9481,7 @@
9481 9481  
9482 9482  ----
9483 9483  
9484 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
9489 +{{code language="yml" theme="RDark" title="Body"}}
9485 9485  {"Name":"Test API term creation","Description":"Test API term creation","Duration":10,"ProductId":599}
9486 9486  {{/code}}
9487 9487  
... ... @@ -9491,7 +9491,7 @@
9491 9491  
9492 9492  (% style="color: rgb(107,107,107);" %)Request
9493 9493  
9494 -{{code language="php" theme="RDark" title="Create Term Request" collapse="true"}}
9499 +{{code language="php" theme="RDark" title="Create Term Request"}}
9495 9495  <?php
9496 9496  
9497 9497  $curl = curl_init();
... ... @@ -9523,7 +9523,7 @@
9523 9523  
9524 9524  \\
9525 9525  
9526 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9531 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9527 9527  
9528 9528  {{code language="yml" theme="RDark" title="Create Term Response" collapse="true"}}
9529 9529  {
... ... @@ -9563,7 +9563,7 @@
9563 9563  
9564 9564  ----
9565 9565  
9566 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
9571 +{{code language="yml" theme="RDark" title="Body"}}
9567 9567  {"Name":"Test API term creation update","Description":"Test API term creation update","Duration":10,"ProductId":599}
9568 9568  {{/code}}
9569 9569  
... ... @@ -9573,7 +9573,7 @@
9573 9573  
9574 9574  (% style="color: rgb(107,107,107);" %)Request
9575 9575  
9576 -{{code language="php" theme="RDark" title="Update Term Request" collapse="true"}}
9581 +{{code language="php" theme="RDark" title="Update Term Request"}}
9577 9577   <?php
9578 9578  
9579 9579  $curl = curl_init();
... ... @@ -9601,7 +9601,7 @@
9601 9601  
9602 9602  \\
9603 9603  
9604 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9609 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9605 9605  
9606 9606  {{code language="yml" theme="RDark" title="Update Term Response" collapse="true"}}
9607 9607   {
... ... @@ -9761,7 +9761,7 @@
9761 9761  
9762 9762  (% style="color: rgb(107,107,107);" %)Request
9763 9763  
9764 -{{code language="php" theme="RDark" title="Get All Resource Request" collapse="true"}}
9769 +{{code language="php" theme="RDark" title="Get All Resource Request"}}
9765 9765   <?php
9766 9766  
9767 9767  $curl = curl_init();
... ... @@ -9788,7 +9788,7 @@
9788 9788  
9789 9789  \\
9790 9790  
9791 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9796 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9792 9792  
9793 9793  {{code language="yml" theme="RDark" title="Get All Resource Response" collapse="true"}}
9794 9794   {
... ... @@ -9907,7 +9907,7 @@
9907 9907  
9908 9908  (% style="color: rgb(107,107,107);" %)Request
9909 9909  
9910 -{{code language="php" theme="RDark" title="Get specific Resource Request" collapse="true"}}
9915 +{{code language="php" theme="RDark" title="Get specific Resource Request"}}
9911 9911   <?php
9912 9912  
9913 9913  $curl = curl_init();
... ... @@ -9934,7 +9934,7 @@
9934 9934  
9935 9935  \\
9936 9936  
9937 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9942 +(% style="color: rgb(107,107,107);" %)Response  200 OK
9938 9938  
9939 9939  {{code language="yml" theme="RDark" title="Get specific Resource Response" collapse="true"}}
9940 9940   {
... ... @@ -9987,7 +9987,7 @@
9987 9987  
9988 9988  (% style="color: rgb(107,107,107);" %)Request
9989 9989  
9990 -{{code language="php" theme="RDark" title="Lookup Resource Request" collapse="true"}}
9995 +{{code language="php" theme="RDark" title="Lookup Resource Request"}}
9991 9991   <?php
9992 9992  
9993 9993  $curl = curl_init();
... ... @@ -10014,7 +10014,7 @@
10014 10014  
10015 10015  \\
10016 10016  
10017 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10022 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10018 10018  
10019 10019  {{code language="yml" theme="RDark" title="Lookup Resource Response" collapse="true"}}
10020 10020   {
... ... @@ -10059,7 +10059,7 @@
10059 10059  
10060 10060  ----
10061 10061  
10062 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10067 +{{code language="yml" theme="RDark" title="Body"}}
10063 10063  {"Name":"Test API product creation 22","Description":"Test API product creation 22","Type":3,"FreePass":1,"Value":["http://one-count.com"],"Gating":false,"Price":0,"PrimaryFormId":"","VendorId":1}
10064 10064  {{/code}}
10065 10065  
... ... @@ -10069,7 +10069,7 @@
10069 10069  
10070 10070  (% style="color: rgb(107,107,107);" %)Request
10071 10071  
10072 -{{code language="php" theme="RDark" title="Create Resource Request" collapse="true"}}
10077 +{{code language="php" theme="RDark" title="Create Resource Request"}}
10073 10073   <?php
10074 10074  
10075 10075  $curl = curl_init();
... ... @@ -10097,7 +10097,7 @@
10097 10097  
10098 10098  \\
10099 10099  
10100 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10105 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10101 10101  
10102 10102  {{code language="yml" theme="RDark" title="Create Resource Response" collapse="true"}}
10103 10103   {
... ... @@ -10142,7 +10142,7 @@
10142 10142  
10143 10143  ----
10144 10144  
10145 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10150 +{{code language="yml" theme="RDark" title="Body"}}
10146 10146  {"Name":"Test API product creation 23","Description":"Test API product creation 23","Type":3,"FreePass":1,"Value":["http://one-count.com","onecount.net"],"Gating":false,"Price":0,"PrimaryFormId":"","VendorId":1}
10147 10147  {{/code}}
10148 10148  
... ... @@ -10152,7 +10152,7 @@
10152 10152  
10153 10153  (% style="color: rgb(107,107,107);" %)Request
10154 10154  
10155 -{{code language="php" theme="RDark" title="Update Resource Request" collapse="true"}}
10160 +{{code language="php" theme="RDark" title="Update Resource Request"}}
10156 10156   <?php
10157 10157  
10158 10158  $curl = curl_init();
... ... @@ -10180,7 +10180,7 @@
10180 10180  
10181 10181  \\
10182 10182  
10183 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10188 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10184 10184  
10185 10185  {{code language="yml" theme="RDark" title="Update Resource Response" collapse="true"}}
10186 10186   {
... ... @@ -10314,7 +10314,7 @@
10314 10314  
10315 10315  (% style="color: rgb(107,107,107);" %)Request
10316 10316  
10317 -{{code language="php" theme="RDark" title="Get All Source code Request" collapse="true"}}
10322 +{{code language="php" theme="RDark" title="Get All Source code Request"}}
10318 10318   <?php
10319 10319  
10320 10320  $curl = curl_init();
... ... @@ -10341,7 +10341,7 @@
10341 10341  
10342 10342  \\
10343 10343  
10344 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10349 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10345 10345  
10346 10346  {{code language="yml" theme="RDark" title="Get All Source code Response" collapse="true"}}
10347 10347   {
... ... @@ -10530,7 +10530,7 @@
10530 10530  
10531 10531  (% style="color: rgb(107,107,107);" %)Request
10532 10532  
10533 -{{code language="php" theme="RDark" title="Get specific Source Request" collapse="true"}}
10538 +{{code language="php" theme="RDark" title="Get specific Source Request"}}
10534 10534   <?php
10535 10535  
10536 10536  $curl = curl_init();
... ... @@ -10557,7 +10557,7 @@
10557 10557  
10558 10558  \\
10559 10559  
10560 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10565 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10561 10561  
10562 10562  {{code language="yml" theme="RDark" title="Get specific Source Response" collapse="true"}}
10563 10563   {
... ... @@ -10608,7 +10608,7 @@
10608 10608  
10609 10609  (% style="color: rgb(107,107,107);" %)Request
10610 10610  
10611 -{{code language="php" theme="RDark" title="Lookup Source code Request" collapse="true"}}
10616 +{{code language="php" theme="RDark" title="Lookup Source code Request"}}
10612 10612   <?php
10613 10613  
10614 10614  $curl = curl_init();
... ... @@ -10635,7 +10635,7 @@
10635 10635  
10636 10636  \\
10637 10637  
10638 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10643 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10639 10639  
10640 10640  {{code language="yml" theme="RDark" title="Lookup Source code Response" collapse="true"}}
10641 10641   {
... ... @@ -10678,7 +10678,7 @@
10678 10678  
10679 10679  ----
10680 10680  
10681 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10686 +{{code language="yml" theme="RDark" title="Body"}}
10682 10682  {"Source":"Test source code from API"}
10683 10683  {{/code}}
10684 10684  
... ... @@ -10688,7 +10688,7 @@
10688 10688  
10689 10689  (% style="color: rgb(107,107,107);" %)Request
10690 10690  
10691 -{{code language="php" theme="RDark" title="Create Source code Request" collapse="true"}}
10696 +{{code language="php" theme="RDark" title="Create Source code Request"}}
10692 10692   <?php
10693 10693  
10694 10694  $curl = curl_init();
... ... @@ -10716,7 +10716,7 @@
10716 10716  
10717 10717  \\
10718 10718  
10719 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10724 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10720 10720  
10721 10721  {{code language="yml" theme="RDark" title="Create Source code Response" collapse="true"}}
10722 10722   {
... ... @@ -10759,7 +10759,7 @@
10759 10759  
10760 10760  ----
10761 10761  
10762 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
10767 +{{code language="yml" theme="RDark" title="Body"}}
10763 10763  {"Source":"Test API","Parent":215}
10764 10764  {{/code}}
10765 10765  
... ... @@ -10769,7 +10769,7 @@
10769 10769  
10770 10770  (% style="color: rgb(107,107,107);" %)Request
10771 10771  
10772 -{{code language="php" theme="RDark" title="Update Source code Request" collapse="true"}}
10777 +{{code language="php" theme="RDark" title="Update Source code Request"}}
10773 10773   <?php
10774 10774  
10775 10775  $curl = curl_init();
... ... @@ -10797,7 +10797,7 @@
10797 10797  
10798 10798  \\
10799 10799  
10800 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10805 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10801 10801  
10802 10802  {{code language="yml" theme="RDark" title="Update Source code Response" collapse="true"}}
10803 10803   {
... ... @@ -10907,7 +10907,7 @@
10907 10907  
10908 10908  (% style="color: rgb(107,107,107);" %)Request
10909 10909  
10910 -{{code language="php" theme="RDark" title="Get All Transaction Request" collapse="true"}}
10915 +{{code language="php" theme="RDark" title="Get All Transaction Request"}}
10911 10911   <?php
10912 10912  
10913 10913  $curl = curl_init();
... ... @@ -10934,7 +10934,7 @@
10934 10934  
10935 10935  \\
10936 10936  
10937 -(% style="color: rgb(107,107,107);" %)Response  200 OK
10942 +(% style="color: rgb(107,107,107);" %)Response  200 OK
10938 10938  
10939 10939  {{code language="yml" theme="RDark" title="Get All Transaction Response" collapse="true"}}
10940 10940   {
... ... @@ -12473,7 +12473,7 @@
12473 12473  
12474 12474  (% style="color: rgb(107,107,107);" %)Request
12475 12475  
12476 -{{code language="php" theme="RDark" title="Get specific Transaction Request" collapse="true"}}
12481 +{{code language="php" theme="RDark" title="Get specific Transaction Request"}}
12477 12477   <?php
12478 12478  
12479 12479  $curl = curl_init();
... ... @@ -12500,7 +12500,7 @@
12500 12500  
12501 12501  \\
12502 12502  
12503 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12508 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12504 12504  
12505 12505  {{code language="yml" theme="RDark" title="Get specific Transaction Response" collapse="true"}}
12506 12506   {
... ... @@ -12560,7 +12560,7 @@
12560 12560  
12561 12561  (% style="color: rgb(107,107,107);" %)Request
12562 12562  
12563 -{{code language="php" theme="RDark" title="Lookup Transaction Request" collapse="true"}}
12568 +{{code language="php" theme="RDark" title="Lookup Transaction Request"}}
12564 12564   <?php
12565 12565  
12566 12566  $curl = curl_init();
... ... @@ -12587,7 +12587,7 @@
12587 12587  
12588 12588  \\
12589 12589  
12590 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12595 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12591 12591  
12592 12592  {{code language="yml" theme="RDark" title="Lookup Transaction Response" collapse="true"}}
12593 12593   {
... ... @@ -12815,7 +12815,7 @@
12815 12815  
12816 12816  ----
12817 12817  
12818 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
12823 +{{code language="yml" theme="RDark" title="Body"}}
12819 12819  {"UserId": 1845775,"TermId":447 ,"UserIP":"192.168.0.1" ,"SubscriptionType":"n" , "ProductId":599 ,"FormId": "8f93834c-adce-4dc7-acd0-f3a1e0f7c63f","Source": 83,"ProductStatus": 2,"Amount":"0.00" ,"PaypalTransId":"" , "MediaFilePath":"" ,"Remarks": "USER SUBSCRIBED","BatchId":"1234" ,"Quantity": 1, "ExpireDate":"20251211" }
12820 12820  {{/code}}
12821 12821  
... ... @@ -12825,7 +12825,7 @@
12825 12825  
12826 12826  (% style="color: rgb(107,107,107);" %)Request
12827 12827  
12828 -{{code language="php" theme="RDark" title="Create Transaction Request" collapse="true"}}
12833 +{{code language="php" theme="RDark" title="Create Transaction Request"}}
12829 12829   <?php
12830 12830  
12831 12831  $curl = curl_init();
... ... @@ -12853,7 +12853,7 @@
12853 12853  
12854 12854  \\
12855 12855  
12856 -(% style="color: rgb(107,107,107);" %)Response  200 OK
12861 +(% style="color: rgb(107,107,107);" %)Response  200 OK
12857 12857  
12858 12858  {{code language="yml" theme="RDark" title="Create Transaction Response" collapse="true"}}
12859 12859   {
... ... @@ -12892,6 +12892,7 @@
12892 12892  (% class="western" %)
12893 12893  \\
12894 12894  
12900 +(% class="wrapped" %)
12895 12895  (% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12896 12896  (((
12897 12897  (% class="western" %)
... ... @@ -13005,7 +13005,7 @@
13005 13005  
13006 13006  (% style="color: rgb(107,107,107);" %)Request
13007 13007  
13008 -{{code language="php" theme="RDark" title="Get All Engagement Request" collapse="true"}}
13014 +{{code language="php" theme="RDark" title="Get All Engagement Request"}}
13009 13009  <?php
13010 13010  
13011 13011  $curl = curl_init();
... ... @@ -13034,6 +13034,52 @@
13034 13034  
13035 13035  \\
13036 13036  
13043 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13044 +
13045 +{{code language="yml" theme="RDark" title="Get all engagements Response" collapse="true"}}
13046 + {
13047 + "result": {
13048 + "success": "1",
13049 + "error": {
13050 + "code": "",
13051 + "message": ""
13052 + }
13053 + },
13054 + "Engagements": [
13055 + {
13056 + "Id": "048d38e9-d6c3-432e-9671-3f31809d48b3",
13057 + "Name": "Test Engagement 1",
13058 + "Engagement Fields": [
13059 + {
13060 + "Name": "id",
13061 + "Type": "text"
13062 + },
13063 + {
13064 + "Name": "activity_time",
13065 + "Type": "text"
13066 + },
13067 + {
13068 + "Name": "Name",
13069 + "Type": "text"
13070 + },
13071 + {
13072 + "Name": "Test Field",
13073 + "Type": "select",
13074 + "Values": [
13075 + {
13076 + "text": "Test 1",
13077 + "value": "Test1"
13078 + }
13079 + ]
13080 + }
13081 + ]
13082 + }
13083 + ]
13084 +}
13085 +{{/code}}
13086 +
13087 +\\
13088 +
13037 13037  (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13038 13038  == (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Specific Engagement(%%) ==
13039 13039  
... ... @@ -13057,7 +13057,7 @@
13057 13057  
13058 13058  (% style="color: rgb(107,107,107);" %)Request
13059 13059  
13060 -{{code language="php" theme="RDark" title="Get Specific Engagement Request" collapse="true"}}
13112 +{{code language="php" theme="RDark" title="Get Specific Engagement Request"}}
13061 13061  <?php
13062 13062  
13063 13063  $curl = curl_init();
... ... @@ -13086,6 +13086,52 @@
13086 13086  
13087 13087  \\
13088 13088  
13141 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13142 +
13143 +{{code language="yml" theme="RDark" title="Get specific engagement Response" collapse="true"}}
13144 + {
13145 + "result": {
13146 + "success": "1",
13147 + "error": {
13148 + "code": "",
13149 + "message": ""
13150 + }
13151 + },
13152 + "Engagements": [
13153 + {
13154 + "Id": "048d38e9-d6c3-432e-9671-3f31809d48b3",
13155 + "Name": "Test Engagement 1",
13156 + "Engagement Fields": [
13157 + {
13158 + "Name": "id",
13159 + "Type": "text"
13160 + },
13161 + {
13162 + "Name": "activity_time",
13163 + "Type": "text"
13164 + },
13165 + {
13166 + "Name": "Name",
13167 + "Type": "text"
13168 + },
13169 + {
13170 + "Name": "Test Field",
13171 + "Type": "select",
13172 + "Values": [
13173 + {
13174 + "text": "Test 1",
13175 + "value": "Test1"
13176 + }
13177 + ]
13178 + }
13179 + ]
13180 + }
13181 + ]
13182 +}
13183 +{{/code}}
13184 +
13185 +\\
13186 +
13089 13089  (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13090 13090  == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Create Engagement(%%) ==
13091 13091  
... ... @@ -13105,7 +13105,7 @@
13105 13105  
13106 13106  ----
13107 13107  
13108 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
13206 +{{code language="yml" theme="RDark" title="Body"}}
13109 13109  {"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13110 13110   {"Name":[{"webinar ID 1":"Webinar 1"},{"webinar ID 3":"Webinar 3"},{"webinar ID 3":"Webinar 3"}],"Type": "select"},
13111 13111   {"Attendance Status":[{"attended":"Attended"},{"not_attended":"Not Attended"}],"Type": "select"},
... ... @@ -13120,8 +13120,8 @@
13120 13120  
13121 13121  (% style="color: rgb(107,107,107);" %)Request
13122 13122  
13123 -{{code language="php" theme="RDark" title="Create Engagement Request" collapse="true"}}
13124 - <?php
13221 +{{code language="php" theme="RDark" title="Create Engagement Request"}}
13222 +<?php
13125 13125  
13126 13126  $curl = curl_init();
13127 13127  
... ... @@ -13134,14 +13134,15 @@
13134 13134   CURLOPT_FOLLOWLOCATION => true,
13135 13135   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13136 13136   CURLOPT_CUSTOMREQUEST => 'POST',
13137 - CURLOPT_POSTFIELDS =>'{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13138 - {"Name":[{"webinar ID 1":"Webinar 1"},{"webinar ID 3":"Webinar 3"},{"webinar ID 3":"Webinar 3"}],"Type": "select"},
13139 - {"Attendance Status":[{"attended":"Attended"},{"not_attended":"Not Attended"}],"Type": "select"},
13235 + CURLOPT_POSTFIELDS =>'{"Name":"Test engagement 2", "Description":"Test engagement 2", "Metrics":[
13236 + {"Name":[{"text":"Webinar 1","value":"Webinar_1"},{"text":"Webinar 2","value":"Webinar_2"}],"Type": "select"},
13237 + {"Attendance Status":[{"text":"Attended","value":"attended"},{"text":"Not Attended","value":"not_attended"}],"Type": "select"},
13140 13140   {"Price":[],"Type": "numeric"},
13141 - {"Transaction Date":[],"Type": "date"}
13239 + {"Transaction Date":[],"Type": "text"}
13142 13142  ]}',
13143 13143   CURLOPT_HTTPHEADER => array(
13144 - 'Appkey: {{ONECOUNT API KEY}}'
13242 + 'Appkey: {{ONECOUNT API KEY}}',
13243 + 'Content-Type: application/json'
13145 13145   ),
13146 13146  ));
13147 13147  
... ... @@ -13149,10 +13149,80 @@
13149 13149  
13150 13150  curl_close($curl);
13151 13151  echo $response;
13251 +
13252 +
13152 13152  {{/code}}
13153 13153  
13154 13154  \\
13155 13155  
13257 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13258 +
13259 +{{code language="yml" theme="RDark" title="Create Engagement Response" collapse="true"}}
13260 + {
13261 + "result": {
13262 + "success": "1",
13263 + "error": {
13264 + "code": "",
13265 + "message": ""
13266 + }
13267 + },
13268 + "Engagements": [
13269 + {
13270 + "Id": "71c1115f-e5bb-470a-bedf-6940f5ac8565",
13271 + "Name": "Test engagement 2",
13272 + "Metrics": [
13273 + {
13274 + "Name": "Name",
13275 + "Type": "select",
13276 + "Values": [
13277 + {
13278 + "text": "Webinar 1",
13279 + "value": "Webinar_1"
13280 + },
13281 + {
13282 + "text": "Webinar 2",
13283 + "value": "Webinar_2"
13284 + }
13285 + ]
13286 + },
13287 + {
13288 + "Name": "Attendance Status",
13289 + "Type": "select",
13290 + "Values": [
13291 + {
13292 + "text": "Attended",
13293 + "value": "attended"
13294 + },
13295 + {
13296 + "text": "Not Attended",
13297 + "value": "not_attended"
13298 + }
13299 + ]
13300 + },
13301 + {
13302 + "Name": "Price",
13303 + "Type": "numeric"
13304 + },
13305 + {
13306 + "Name": "Transaction Date",
13307 + "Type": "text"
13308 + },
13309 + {
13310 + "Name": "id",
13311 + "Type": "text"
13312 + },
13313 + {
13314 + "Name": "activity_time",
13315 + "Type": "text"
13316 + }
13317 + ]
13318 + }
13319 + ]
13320 +}
13321 +{{/code}}
13322 +
13323 +\\
13324 +
13156 13156  (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13157 13157  == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(0, 83, 184)" %)PUT (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)Update Engagement(%%) ==
13158 13158  
... ... @@ -13172,11 +13172,11 @@
13172 13172  
13173 13173  ----
13174 13174  
13175 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
13176 -{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13177 - {"Name":[{"webinar ID 5":"Webinar 5"},{"webinar ID 4":"Webinar 4"}],"Type": "select"},
13344 +{{code language="yml" theme="RDark" title="Body"}}
13345 +{"Name":"Test engagement 3", "Metrics":[
13346 + {"Attendance Status":[{"text":"Attended","value":"attended"},{"text":"Not Attended","value":"not_attended"}],"Type": "select"},
13178 13178   {"Price":[],"Type": "text"}
13179 -]}
13348 + ]}
13180 13180  {{/code}}
13181 13181  
13182 13182  ==== Example ====
... ... @@ -13185,7 +13185,7 @@
13185 13185  
13186 13186  (% style="color: rgb(107,107,107);" %)Request
13187 13187  
13188 -{{code language="php" theme="RDark" title="Update Engagement Request" collapse="true"}}
13357 +{{code language="php" theme="RDark" title="Update Engagement Request"}}
13189 13189   <?php
13190 13190  
13191 13191  $curl = curl_init();
... ... @@ -13199,12 +13199,13 @@
13199 13199   CURLOPT_FOLLOWLOCATION => true,
13200 13200   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13201 13201   CURLOPT_CUSTOMREQUEST => 'PUT',
13202 - CURLOPT_POSTFIELDS =>'{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13203 - {"Name":[{"webinar ID 5":"Webinar 5"},{"webinar ID 4":"Webinar 4"}],"Type": "select"},
13371 + CURLOPT_POSTFIELDS =>'{"Name":"Test engagement 3", "Metrics":[
13372 + {"Attendance Status":[{"text":"Attended","value":"attended"},{"text":"Not Attended","value":"not_attended"}],"Type": "select"},
13204 13204   {"Price":[],"Type": "text"}
13205 -]}',
13374 + ]}',
13206 13206   CURLOPT_HTTPHEADER => array(
13207 - 'Appkey: {{ONECOUNT API KEY}}'
13376 + 'Appkey: {{ONECOUNT API KEY}}',
13377 + 'Content-Type: application/json'
13208 13208   ),
13209 13209  ));
13210 13210  
... ... @@ -13212,10 +13212,79 @@
13212 13212  
13213 13213  curl_close($curl);
13214 13214  echo $response;
13385 +
13215 13215  {{/code}}
13216 13216  
13217 13217  \\
13218 13218  
13390 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13391 +
13392 +{{code language="yml" theme="RDark" title="Update Engagement Response" collapse="true"}}
13393 +{
13394 + "result": {
13395 + "success": "1",
13396 + "error": {
13397 + "code": "",
13398 + "message": ""
13399 + }
13400 + },
13401 + "Engagements": [
13402 + {
13403 + "Id": "e0e816ec-77ba-4db1-bfc0-22d340337357",
13404 + "Name": "Test engagement 3",
13405 + "Metrics": [
13406 + {
13407 + "Name": "Attendance Status",
13408 + "Type": "select",
13409 + "Values": [
13410 + {
13411 + "text": "Attended",
13412 + "value": "attended"
13413 + },
13414 + {
13415 + "text": "Not Attended",
13416 + "value": "not_attended"
13417 + }
13418 + ]
13419 + },
13420 + {
13421 + "Name": "Price",
13422 + "Type": "text"
13423 + },
13424 + {
13425 + "Name": "Name",
13426 + "Type": "select",
13427 + "Values": [
13428 + {
13429 + "text": "Webinar 1",
13430 + "value": "Webinar_1"
13431 + },
13432 + {
13433 + "text": "Webinar 2",
13434 + "value": "Webinar_2"
13435 + }
13436 + ]
13437 + },
13438 + {
13439 + "Name": "Transaction Date",
13440 + "Type": "text"
13441 + },
13442 + {
13443 + "Name": "id",
13444 + "Type": "text"
13445 + },
13446 + {
13447 + "Name": "activity_time",
13448 + "Type": "text"
13449 + }
13450 + ]
13451 + }
13452 + ]
13453 +}
13454 +{{/code}}
13455 +
13456 +\\
13457 +
13219 13219  (% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13220 13220  == (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Add User to Engagement(%%) ==
13221 13221  
... ... @@ -13235,8 +13235,8 @@
13235 13235  
13236 13236  ----
13237 13237  
13238 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
13239 -{"Engagement id":"073b3a98-129b-440e-90b1-57957215ca67","Vendor id":1, "Engagement show id":"webinar ID 4","User id":"3143231","timestamp":1702319997, "data":{"Attendance Status":"not_attended","Price":10.00},"segment":["segment id 1"]}
13477 +{{code language="yml" theme="RDark" title="Body"}}
13478 +{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","show id":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}
13240 13240  {{/code}}
13241 13241  
13242 13242  ==== Example ====
... ... @@ -13245,7 +13245,7 @@
13245 13245  
13246 13246  (% style="color: rgb(107,107,107);" %)Request
13247 13247  
13248 -{{code language="php" theme="RDark" title="Add User to Engagement Request" collapse="true"}}
13487 +{{code language="php" theme="RDark" title="Add User to Engagement Request"}}
13249 13249   <?php
13250 13250  
13251 13251  $curl = curl_init();
... ... @@ -13259,7 +13259,7 @@
13259 13259   CURLOPT_FOLLOWLOCATION => true,
13260 13260   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13261 13261   CURLOPT_CUSTOMREQUEST => 'POST',
13262 - CURLOPT_POSTFIELDS =>'{"Engagement id":"073b3a98-129b-440e-90b1-57957215ca67","Vendor id":1, "Engagement show id":"webinar ID 4","User id":"3143231","timestamp":1702319997, "data":{"Attendance Status":"not_attended","Price":10.00},"segment":["segment id 1"]}',
13501 + CURLOPT_POSTFIELDS =>'{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","show id":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}',
13263 13263   CURLOPT_HTTPHEADER => array(
13264 13264   'Appkey: {{ONECOUNT API KEY}}'
13265 13265   ),
... ... @@ -13271,7 +13271,594 @@
13271 13271  echo $response;
13272 13272  {{/code}}
13273 13273  
13513 +\\
13514 +
13515 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13516 +
13517 +{{code language="yml" theme="RDark" title="Add Users to Engagement Response" collapse="true"}}
13518 + {
13519 + "result": {
13520 + "success": "1",
13521 + "error": {
13522 + "code": "",
13523 + "message": ""
13524 + }
13525 + },
13526 + "Users": {
13527 + "ocid": 1845775,
13528 + "uuid": {
13529 + "type": {
13530 + "name": "uuid"
13531 + },
13532 + "uuid": "a1425a04-4c0c-4790-bcd6-425bc7729fd7",
13533 + "version": 4
13534 + },
13535 + "blacklisted": null,
13536 + "demo": {
13537 + "1": "rayaan@one-count.com",
13538 + "2": "user_1701788987",
13539 + "3": "5994471abb01112afcc18159f6cc74b4f511b99806da59b3caf5a9c173cacfc5"
13540 + },
13541 + "email": "rayaan@one-count.com",
13542 + "espid": null,
13543 + "known": {
13544 + "type": {
13545 + "name": "smallint"
13546 + },
13547 + "value": "1"
13548 + },
13549 + "ocid_hash": "57b81cf5536171c84e6e8a0b762251ee7819737b2e95f1390fed97acc11a277b",
13550 + "partners_hash": null,
13551 + "password": "5994471abb01112afcc18159f6cc74b4f511b99806da59b3caf5a9c173cacfc5",
13552 + "payment_cc_exp": null,
13553 + "payment_vendor_token": null,
13554 + "products": {
13555 + "599": "447"
13556 + },
13557 + "remarks": null,
13558 + "resources": null,
13559 + "smartlink_hash": null,
13560 + "subscription_active_resource_info": null,
13561 + "subscription_active_term_info": {
13562 + "447": "{\"renewed\":1,\"expiration_month\":202512,\"product_status\":\"2\",\"expiration_date\":20251211}"
13563 + },
13564 + "subscription_log": {
13565 + "type": {
13566 + "valueType": {
13567 + "name": "varchar"
13568 + }
13569 + },
13570 + "values": [
13571 + "{\"batch_id\":\"1234\",\"__cuuid\":\"49\",\"subscription_time\":\"2023-12-11 09:09:01\",\"product_status\":\"2\",\"promo_code\":\"\",\"type\":\"term\",\"expiration_date\":20251211,\"subscription_date\":20231211,\"ocid\":1845775,\"product_uid\":\"599\",\"timestamp\":1702303741,\"amount\":0,\"quantity\":1,\"import_id\":\"83\",\"ip\":\"10.10.20.7\",\"form_id\":\"8f93834c-adce-4dc7-acd0-f3a1e0f7c63f\",\"previous_expiration_date\":20231211,\"term_uid\":\"447\",\"renewed\":1,\"request_date\":20231211,\"payment_transaction_id\":\"0\",\"subscription_type\":\"n\",\"payment_processor\":\"\",\"remarks\":\"USER SUBSCRIBED\",\"user_uid\":\"a1425a04-4c0c-4790-bcd6-425bc7729fd7\"}",
13572 + "{\"batch_id\":\"1234\",\"__cuuid\":\"49\",\"subscription_time\":\"2023-12-11 09:20:49\",\"product_status\":\"2\",\"promo_code\":\"\",\"type\":\"term\",\"expiration_date\":20251211,\"subscription_date\":20231211,\"ocid\":1845775,\"product_uid\":\"599\",\"timestamp\":1702304449,\"amount\":0,\"quantity\":1,\"import_id\":\"83\",\"ip\":\"10.10.20.7\",\"form_id\":\"8f93834c-adce-4dc7-acd0-f3a1e0f7c63f\",\"previous_expiration_date\":20231211,\"term_uid\":\"447\",\"renewed\":1,\"request_date\":20231211,\"payment_transaction_id\":\"0\",\"subscription_type\":\"n\",\"payment_processor\":\"\",\"remarks\":\"USER SUBSCRIBED\",\"user_uid\":\"a1425a04-4c0c-4790-bcd6-425bc7729fd7\"}",
13573 + "{\"batch_id\":\"1234\",\"__cuuid\":\"49\",\"subscription_time\":\"2023-12-11 09:34:26\",\"product_status\":\"2\",\"promo_code\":\"\",\"type\":\"term\",\"expiration_date\":20251211,\"subscription_date\":20231211,\"ocid\":1845775,\"product_uid\":\"599\",\"timestamp\":1702305266,\"amount\":0,\"quantity\":1,\"import_id\":\"83\",\"ip\":\"10.10.20.7\",\"form_id\":\"8f93834c-adce-4dc7-acd0-f3a1e0f7c63f\",\"previous_expiration_date\":20231211,\"term_uid\":\"447\",\"renewed\":1,\"request_date\":20231211,\"payment_transaction_id\":\"0\",\"subscription_type\":\"n\",\"payment_processor\":\"\",\"remarks\":\"USER SUBSCRIBED\",\"user_uid\":\"a1425a04-4c0c-4790-bcd6-425bc7729fd7\"}"
13574 + ]
13575 + },
13576 + "subscription_log_by_resource": null,
13577 + "subscription_source_code": [
13578 + "83"
13579 + ],
13580 + "targets": null,
13581 + "timestamp": {
13582 + "type": {
13583 + "name": "bigint"
13584 + },
13585 + "value": "1701788987"
13586 + },
13587 + "unconfirmed": null,
13588 + "update_time": null,
13589 + "username": "user_1701788987",
13590 + "vendor_blacklisted": null,
13591 + "vendor_esp": null,
13592 + "vendor_unconfirmed": null
13593 + }
13594 +}
13595 +{{/code}}
13596 +
13597 +\\
13598 +
13274 13274  (% class="western" %)
13600 +=== **COMPONENT: Segments
13601 +** ===
13602 +
13603 +(% class="western" %)
13604 +This resource is for manipulating segment for a resource. A segment can be searched (or) add users to segment (or)  get all segment for a user.
13605 +
13606 +(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13607 +(((
13608 +(% class="western" %)
13609 +**Method**
13610 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13611 +(((
13612 +(% class="western" %)
13613 +**Url**
13614 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13615 +(((
13616 +(% class="western" %)
13617 +**Action**
13618 +)))
13619 +(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13620 +(((
13621 +(% class="western" %)
13622 +GET
13623 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13624 +(((
13625 +(% class="western" %)
13626 +/(% style="color: rgb(33,33,33);" %)segments
13627 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13628 +(((
13629 +(% class="western" %)
13630 +Get all segments.
13631 +)))
13632 +(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13633 +(((
13634 +(% class="western" %)
13635 +GET
13636 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13637 +(((
13638 +(% class="western" %)
13639 +/(% style="color: rgb(33,33,33);" %)segments(%%)/(% class="resolvedVariable" style="text-decoration: none;" %)~{~{Segment id}}
13640 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13641 +(((
13642 +(% class="western" %)
13643 +Get specific segment based on segment id.
13644 +)))
13645 +(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13646 +(((
13647 +(% class="western" %)
13648 +POST
13649 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13650 +(((
13651 +(% class="western" %)
13652 +/(% style="color: rgb(33,33,33);" %)segments/addUsers
13653 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13654 +(((
13655 +(% class="western" %)
13656 +Add users to segment.
13657 +)))
13658 +(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13659 +(((
13660 +(% class="western" %)
13661 +GET
13662 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13663 +(((
13664 +(% class="western" %)
13665 +/(% style="color: rgb(33,33,33);" %)segments/users/(% class="resolvedVariable" style="text-decoration: none;" %)~{~{ocid}}
13666 +)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
13667 +(((
13668 +(% class="western" %)
13669 +Get all segment user has be subscribed based on user id.
13670 +)))
13671 +
13672 +\\
13673 +
13674 +(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13675 +== (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)All Segments(%%) ==
13676 +
13677 +----
13678 +
13679 +----
13680 +
13681 +{{panel bgColor="#D3D3D3" width="100%"}}
13682 +(% class="nolink nolink" %)https:~/~/api.onecount.net/v2(% class="nolink" style="color: rgb(33,33,33);" %)/segments
13683 +{{/panel}}
13684 +
13685 +=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13686 +
13687 +----
13688 +
13689 +(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13690 +
13691 +==== Example ====
13692 +
13693 +----
13694 +
13695 +(% style="color: rgb(107,107,107);" %)Request
13696 +
13697 +{{code language="php" theme="RDark" title="Get All Segments Request"}}
13698 +<?php
13699 +
13700 +$curl = curl_init();
13701 +
13702 +curl_setopt_array($curl, array(
13703 + CURLOPT_URL => 'https://api.onecount.net/v2/segments',
13704 + CURLOPT_RETURNTRANSFER => true,
13705 + CURLOPT_ENCODING => '',
13706 + CURLOPT_MAXREDIRS => 10,
13707 + CURLOPT_TIMEOUT => 0,
13708 + CURLOPT_FOLLOWLOCATION => true,
13709 + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13710 + CURLOPT_CUSTOMREQUEST => 'GET',
13711 + CURLOPT_HTTPHEADER => array(
13712 + 'Appkey: {{ONECOUNT API KEY}}'
13713 + ),
13714 +));
13715 +
13716 +$response = curl_exec($curl);
13717 +
13718 +curl_close($curl);
13719 +echo $response;
13720 +{{/code}}
13721 +
13722 +\\
13723 +
13724 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13725 +
13726 +{{code language="yml" theme="RDark" title="Get All Segments Response" collapse="true"}}
13727 + {
13728 + "result": {
13729 + "success": "1",
13730 + "error": {
13731 + "code": "",
13732 + "message": ""
13733 + }
13734 + },
13735 + "Segments": [
13736 + {
13737 + "Id": "891aa4b6-9e0e-4706-b08a-e7acb54e7e43",
13738 + "Name": "2022 Use Cases PDF Download"
13739 + },
13740 + {
13741 + "Id": "a639cb1f-6509-447b-a1d7-93a8e8ef61b1",
13742 + "Name": "58-percent conversion-rate"
13743 + },
13744 + {
13745 + "Id": "43eefdc6-89ab-4472-88c3-e16fb9619138",
13746 + "Name": "Audience Marketing Pop-Up"
13747 + },
13748 + {
13749 + "Id": "68219b37-c155-4459-a5ce-497261286ffe",
13750 + "Name": "Bold Minds Reminders"
13751 + },
13752 + {
13753 + "Id": "6450defc-7658-4182-9c2a-a8f8420f801e",
13754 + "Name": "Demo - Aviator's Guide - NL Popup"
13755 + },
13756 + {
13757 + "Id": "28774f7c-9fd3-4dff-a42e-683460f437c0",
13758 + "Name": "Getting 80-Percent Conversion Rates Pop-up"
13759 + },
13760 + {
13761 + "Id": "71b655e6-a11a-46af-bed5-b9eb1d6ac3aa",
13762 + "Name": "Holiday Special Offer - 3 mo. Pilot"
13763 + },
13764 + {
13765 + "Id": "16305ad0-8e65-4085-942e-04d99fd39207",
13766 + "Name": "Identity Resolution Test II"
13767 + },
13768 + {
13769 + "Id": "fcdfa9cb-baa2-4cc8-86b3-8f604471f2f3",
13770 + "Name": "Live ONEcount Popup Example Segment"
13771 + },
13772 + {
13773 + "Id": "2463b0a3-1e22-4fd0-97b2-bbdae30e585a",
13774 + "Name": "Live webinar - June 15 - Accelerate Revenue"
13775 + },
13776 + {
13777 + "Id": "d8d1bc9d-ede2-4c82-a747-10ab9fb979de",
13778 + "Name": "LIVE WEBINAR ONEcount BI Pop-up Campaign"
13779 + },
13780 + {
13781 + "Id": "d883ecdb-5307-416d-9558-c196472021c9",
13782 + "Name": "New Year - Increase Revenue 30-Percent"
13783 + },
13784 + {
13785 + "Id": "08abbc5b-aafe-4834-90f5-ac45fe025d73",
13786 + "Name": "OC Test"
13787 + },
13788 + {
13789 + "Id": "24cf72e9-ad71-489c-89ef-b80d0c42e2e2",
13790 + "Name": "Something big"
13791 + },
13792 + {
13793 + "Id": "0d37c79e-deb2-4287-9444-ae4812a9d8f0",
13794 + "Name": "Something No Other Platform Has"
13795 + },
13796 + {
13797 + "Id": "5eaa0345-a825-4ba0-a787-336312a77744",
13798 + "Name": "Something Revolutionary"
13799 + },
13800 + {
13801 + "Id": "c905d313-8d5e-45c1-aaab-7f8c8adc2bea",
13802 + "Name": "Something that will change your life"
13803 + },
13804 + {
13805 + "Id": "1bfb1c06-4b26-4ac3-a616-eb6b225e5f0e",
13806 + "Name": "Something You Have Always Wanted"
13807 + },
13808 + {
13809 + "Id": "28361c73-e253-49bb-a791-5481be2070a0",
13810 + "Name": "Something You Never Thought Possible"
13811 + },
13812 + {
13813 + "Id": "86e7129a-a538-4c56-a731-7e9c08fa8814",
13814 + "Name": "Test behaviour "
13815 + },
13816 + {
13817 + "Id": "e5e53cd4-bbd0-465b-b426-e267964fd0b4",
13818 + "Name": "Test behaviour banner segment"
13819 + },
13820 + {
13821 + "Id": "78ffd6d7-0b40-4e5a-8f32-622a04fb5561",
13822 + "Name": "Test behaviour combo"
13823 + },
13824 + {
13825 + "Id": "0022394d-7901-4aff-98c2-0c8c04fcb27a",
13826 + "Name": "Test behaviour content"
13827 + },
13828 + {
13829 + "Id": "89424642-1363-476e-9842-4f0a2544151f",
13830 + "Name": "Test behaviour email"
13831 + },
13832 + {
13833 + "Id": "ca848e53-3f3e-43c6-ae61-f331f3135c6c",
13834 + "Name": "Test demographic segments"
13835 + },
13836 + {
13837 + "Id": "e11d11fa-7603-4dee-a361-c6e909249ecd",
13838 + "Name": "Test with unknown only selecting all filters"
13839 + }
13840 + ]
13841 +}
13842 +{{/code}}
13843 +
13844 +\\
13845 +
13846 +(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13847 +== (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)specific Segments(%%) ==
13848 +
13849 +----
13850 +
13851 +{{panel bgColor="#D3D3D3" width="100%"}}
13852 + (% class="nolink nolink" %)https:~/~/api.onecount.net/v2(% class="nolink" style="color: rgb(33,33,33);" %)/segments/~{~{segment id}}
13853 +{{/panel}}
13854 +
13855 +=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13856 +
13857 +----
13858 +
13859 +(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13860 +
13861 +==== Example ====
13862 +
13863 +----
13864 +
13865 +(% style="color: rgb(107,107,107);" %)Request
13866 +
13867 +{{code language="php" theme="RDark" title="Get specific Segment Request"}}
13868 + <?php
13869 +
13870 +$curl = curl_init();
13871 +
13872 +curl_setopt_array($curl, array(
13873 + CURLOPT_URL => 'https://api.onecount.net/v2/segments/{{segment id}}',
13874 + CURLOPT_RETURNTRANSFER => true,
13875 + CURLOPT_ENCODING => '',
13876 + CURLOPT_MAXREDIRS => 10,
13877 + CURLOPT_TIMEOUT => 0,
13878 + CURLOPT_FOLLOWLOCATION => true,
13879 + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13880 + CURLOPT_CUSTOMREQUEST => 'GET',
13881 + CURLOPT_HTTPHEADER => array(
13882 + 'Appkey: {{ONECOUNT API KEY}}'
13883 + ),
13884 +));
13885 +
13886 +$response = curl_exec($curl);
13887 +
13888 +curl_close($curl);
13889 +echo $response;
13890 +{{/code}}
13891 +
13892 +\\
13893 +
13894 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13895 +
13896 +{{code language="yml" theme="RDark" title="Get specific Segments Response" collapse="true"}}
13897 + {
13898 + "result": {
13899 + "success": "1",
13900 + "error": {
13901 + "code": "",
13902 + "message": ""
13903 + }
13904 + },
13905 + "Segments": {
13906 + "Id": "e5e53cd4-bbd0-465b-b426-e267964fd0b4",
13907 + "Demos": {
13908 + "_empty_": [],
13909 + "type": ""
13910 + },
13911 + "Description": "",
13912 + "Action": {
13913 + "action": {}
13914 + },
13915 + "Name": "Test behaviour banner segment",
13916 + "Behaviours": [
13917 + {
13918 + "end_date": "05/26/2022",
13919 + "date_type": "Future",
13920 + "sub_category_values": [],
13921 + "sub_category": "clicked",
13922 + "category": "1",
13923 + "targets": [
13924 + "all"
13925 + ],
13926 + "joining_logic": "AND",
13927 + "frequency": "1",
13928 + "start_date": "04/26/2022",
13929 + "day_count": "100"
13930 + }
13931 + ],
13932 + "Accounts": []
13933 + }
13934 +}
13935 +{{/code}}
13936 +
13937 +\\
13938 +
13939 +(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13940 +== (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33, 33, 33); color: rgb(173, 122, 3)" %)POST(% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %) Add users to segments(%%) ==
13941 +
13942 +----
13943 +
13944 +{{panel bgColor="#D3D3D3" width="100%"}}
13945 +(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/segments/addUsers
13946 +{{/panel}}
13947 +
13948 +=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13949 +
13950 +----
13951 +
13952 +(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
13953 +
13954 +=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13955 +
13956 +----
13957 +
13958 +{{code language="yml" theme="RDark" title="Body"}}
13959 +{"Id":"78ffd6d7-0b40-4e5a-8f32-622a04fb5561","Users":[164499,676172,2134321]}
13960 +{{/code}}
13961 +
13962 +==== Example ====
13963 +
13964 +----
13965 +
13966 +(% style="color: rgb(107,107,107);" %)Request
13967 +
13968 +{{code language="php" theme="RDark" title="Add users to Segment Request"}}
13969 +<?php
13970 +
13971 +$curl = curl_init();
13972 +
13973 +curl_setopt_array($curl, array(
13974 + CURLOPT_URL => 'https://api.onecount.net/v2/segments/addUsers',
13975 + CURLOPT_RETURNTRANSFER => true,
13976 + CURLOPT_ENCODING => '',
13977 + CURLOPT_MAXREDIRS => 10,
13978 + CURLOPT_TIMEOUT => 0,
13979 + CURLOPT_FOLLOWLOCATION => true,
13980 + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13981 + CURLOPT_CUSTOMREQUEST => 'POST',
13982 + CURLOPT_POSTFIELDS =>'{"Id":"78ffd6d7-0b40-4e5a-8f32-622a04fb5561","Users":[164499,676172,2134321]}',
13983 + CURLOPT_HTTPHEADER => array(
13984 + 'Appkey: {{ONECOUNT API KEY}}',
13985 + 'Content-Type: application/json'
13986 + ),
13987 +));
13988 +
13989 +$response = curl_exec($curl);
13990 +
13991 +curl_close($curl);
13992 +echo $response;
13993 +{{/code}}
13994 +
13995 +\\
13996 +
13997 +(% style="color: rgb(107,107,107);" %)Response  200 OK
13998 +
13999 +{{code language="yml" theme="RDark" title="Add users to segment Response" collapse="true"}}
14000 +{
14001 + "result": {
14002 + "success": "1",
14003 + "error": {
14004 + "code": "",
14005 + "message": ""
14006 + }
14007 + },
14008 + "Segments": {
14009 + "Error user ids": [
14010 + 676172,
14011 + 2134321
14012 + ],
14013 + "Inserted user ids": [
14014 + 164499
14015 + ]
14016 + }
14017 +}
14018 +{{/code}}
14019 +
14020 +\\
14021 +
14022 +(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
14023 +== (% class="sc-fzoaKM imuBmi" style="color: rgb(0,127,49);" %)GET (% class="sc-fzomuh jbmEtY documentation-core-item-request-name" style="color: rgb(33,33,33);" %)all segments for a User(%%) ==
14024 +
14025 +----
14026 +
14027 +{{panel bgColor="#D3D3D3" width="100%"}}
14028 + (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/segments/users/(% class="nolink resolvedVariable" style="text-decoration: none;" %)~{~{ocid}}
14029 +{{/panel}}
14030 +
14031 +=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
14032 +
14033 +----
14034 +
14035 +(% class="Text__TextContainer-sc-1kqigik-0 iauueY sc-fznXWL cEvDCP item-key" style="color: rgb(33,33,33);" %)Appkey  (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color: rgb(33,33,33);" %)~{~{ONECOUNT API KEY}}
14036 +
14037 +==== Example ====
14038 +
14039 +----
14040 +
14041 +(% style="color: rgb(107,107,107);" %)Request
14042 +
14043 +{{code language="php" theme="RDark" title="Get all segments for a user Request"}}
14044 +<?php
14045 +
14046 +$curl = curl_init();
14047 +
14048 +curl_setopt_array($curl, array(
14049 + CURLOPT_URL => 'rayaan.onecount.net/api/v2/segments/users/••••••',
14050 + CURLOPT_RETURNTRANSFER => true,
14051 + CURLOPT_ENCODING => '',
14052 + CURLOPT_MAXREDIRS => 10,
14053 + CURLOPT_TIMEOUT => 0,
14054 + CURLOPT_FOLLOWLOCATION => true,
14055 + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
14056 + CURLOPT_CUSTOMREQUEST => 'GET',
14057 + CURLOPT_HTTPHEADER => array(
14058 + 'Appkey: {{ONECOUNT API KEY}}'
14059 + ),
14060 +));
14061 +
14062 +$response = curl_exec($curl);
14063 +
14064 +curl_close($curl);
14065 +echo $response;
14066 +{{/code}}
14067 +
14068 +\\
14069 +
14070 +(% style="color: rgb(107,107,107);" %)Response  200 OK
14071 +
14072 +{{code language="yml" theme="RDark" title="Get all Segments for a user Response" collapse="true"}}
14073 +{
14074 + "result": {
14075 + "success": "1",
14076 + "error": {
14077 + "code": "",
14078 + "message": ""
14079 + }
14080 + },
14081 + "Segments": [
14082 + "0d37c79e-deb2-4287-9444-ae4812a9d8f0",
14083 + "1bfb1c06-4b26-4ac3-a616-eb6b225e5f0e",
14084 + "24cf72e9-ad71-489c-89ef-b80d0c42e2e2",
14085 + "28361c73-e253-49bb-a791-5481be2070a0",
14086 + "28774f7c-9fd3-4dff-a42e-683460f437c0",
14087 + "5eaa0345-a825-4ba0-a787-336312a77744",
14088 + "71b655e6-a11a-46af-bed5-b9eb1d6ac3aa",
14089 + "a639cb1f-6509-447b-a1d7-93a8e8ef61b1",
14090 + "bcb403a2-c0a1-414f-90c1-277a41009c97",
14091 + "c905d313-8d5e-45c1-aaab-7f8c8adc2bea",
14092 + "d883ecdb-5307-416d-9558-c196472021c9",
14093 + "d8d1bc9d-ede2-4c82-a747-10ab9fb979de"
14094 + ]
14095 +}
14096 +{{/code}}
14097 +
14098 +\\
14099 +
14100 +(% class="western" %)
13275 13275  === **COMPONENT: Leads
13276 13276  ** ===
13277 13277  
Screen Shot 2020-02-26 at 11.14.29 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +397.9 KB
Content
Screen Shot 2020-02-26 at 11.15.52 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +50.1 KB
Content
Screen Shot 2020-02-26 at 11.22.13 AM.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +159.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -108265485
1 +108265477
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/108265485/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/108265477/ONEcount API Documentation