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 4.1
edited by rayaan@one-count_com
on 2023/12/12 07:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1474,7 +1474,7 @@
1474 1474  \\
1475 1475  
1476 1476  (% class="western" %)
1477 -=== **COMPONENT: Questions** ===
1477 +**COMPONENT: Questions**
1478 1478  
1479 1479  (% class="western" %)
1480 1480  All data fields in ONEcount are made up of questions. Questions are configurable on a per-client basis, and no two customer installations will have the same question (ie., field) layout. Therefore, before querying or updating any ONEcount installation, you'll need to get an understanding of the question layout of the installation. This API segment will allow you to query ONEcount to determine the question layout for the installation. It will also allow you to create new questions within the system. This resource does not allow you to update the data for a specific user (see User section).
... ... @@ -8246,7 +8246,7 @@
8246 8246  \\
8247 8247  
8248 8248  (% class="western" %)
8249 -=== **COMPONENT: Products** ===
8249 +**COMPONENT: Products**
8250 8250  
8251 8251  (% class="western" %)
8252 8252  This resource is for manipulating products resource. A product can be created, updated or searched.
... ... @@ -8974,80 +8974,8 @@
8974 8974  
8975 8975  \\
8976 8976  
8977 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
8978 -== (% 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);" %) Attach Resource to Product(%%) ==
8979 -
8980 -----
8981 -
8982 -{{panel bgColor="#D3D3D3" width="100%"}}
8983 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/products/attachResource
8984 -{{/panel}}
8985 -
8986 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
8987 -
8988 -----
8989 -
8990 -(% 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}}
8991 -
8992 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
8993 -
8994 -----
8995 -
8996 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
8997 -{"ProductID":"599","ResourceID":"903"}
8998 -{{/code}}
8999 -
9000 -==== Example ====
9001 -
9002 -----
9003 -
9004 -(% style="color: rgb(107,107,107);" %)Request
9005 -
9006 -{{code language="php" theme="RDark" title="Attach Resource to Product Request" collapse="true"}}
9007 - <?php
9008 -
9009 -$curl = curl_init();
9010 -
9011 -curl_setopt_array($curl, array(
9012 - CURLOPT_URL => 'https://api.onecount.net/v2/products/attachResource',
9013 - CURLOPT_RETURNTRANSFER => true,
9014 - CURLOPT_ENCODING => '',
9015 - CURLOPT_MAXREDIRS => 10,
9016 - CURLOPT_TIMEOUT => 0,
9017 - CURLOPT_FOLLOWLOCATION => true,
9018 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
9019 - CURLOPT_CUSTOMREQUEST => 'POST',
9020 - CURLOPT_POSTFIELDS =>'{"ProductID":"599","ResourceID":"903"}',
9021 - CURLOPT_HTTPHEADER => array(
9022 - 'Appkey: {{ONECOUNT API KEY}}'
9023 - ),
9024 -));
9025 -
9026 -$response = curl_exec($curl);
9027 -
9028 -curl_close($curl);
9029 -echo $response;
9030 -{{/code}}
9031 -
9032 -\\
9033 -
9034 -(% style="color: rgb(107,107,107);" %)Response  200 OK
9035 -
9036 -{{code language="yml" theme="RDark" title="Create Product Response" collapse="true"}}
9037 - {
9038 - "result": {
9039 - "success": "1",
9040 - "error": {
9041 - "code": "",
9042 - "message": ""
9043 - }
9044 - },
9045 - "Products": "599"
9046 -}
9047 -{{/code}}
9048 -
9049 9049  (% class="western" %)
9050 -=== **COMPONENT: Terms** ===
8978 +**COMPONENT: Terms**
9051 9051  
9052 9052  (% class="western" %)
9053 9053  This resource is for manipulating terms resource. A term can be created, updated or searched.
... ... @@ -9629,7 +9629,7 @@
9629 9629  \\
9630 9630  
9631 9631  (% class="western" %)
9632 -=== **COMPONENT: Resources** ===
9560 +**COMPONENT: Resources**
9633 9633  
9634 9634  (% class="western" %)
9635 9635  Resources are the available entities that can be accessed/modified via API. Each resource can be created, updated or requested by using the corresponding http method described above.
... ... @@ -10216,8 +10216,8 @@
10216 10216  \\
10217 10217  
10218 10218  (% class="western" %)
10219 -=== **COMPONENT: Source Codes
10220 -** ===
10147 +**COMPONENT: Source Codes
10148 +**
10221 10221  
10222 10222  (% class="western" %)
10223 10223  This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
... ... @@ -10823,7 +10823,7 @@
10823 10823  \\
10824 10824  
10825 10825  (% class="western" %)
10826 -=== **COMPONENT: Transactions** ===
10754 +**COMPONENT: Transactions**
10827 10827  
10828 10828  (% class="western" %)
10829 10829  This resource is for manipulating transactions resource. A transaction can be created or searched.
... ... @@ -12884,396 +12884,57 @@
12884 12884  
12885 12885  \\
12886 12886  
12887 -=== **COMPONENT: Engagements** ===
12815 +\\
12888 12888  
12889 -(% class="western" %)
12890 -Engagement can be added, updated and searched for using the engagements resource from the api.
12817 +\\
12891 12891  
12892 -(% class="western" %)
12893 12893  \\
12894 12894  
12895 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12896 -(((
12897 -(% class="western" %)
12898 -**Method**
12899 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12900 -(((
12901 -(% class="western" %)
12902 -**Url**
12903 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12904 -(((
12905 -(% class="western" %)
12906 -**Action**
12907 -)))
12908 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12909 -(((
12910 -(% class="western" %)
12911 -GET
12912 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12913 -(((
12914 -(% class="western" %)
12915 -/(% style="color: rgb(33,33,33);" %)engagements
12916 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12917 -(((
12918 -(% class="western" %)
12919 -Get engagement data limiting 25.
12920 -)))
12921 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12922 -(((
12923 -(% class="western" %)
12924 -GET
12925 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12926 -(((
12927 -(% class="western" %)
12928 -/(% style="color: rgb(33,33,33);" %)engagements(%%)/<engagement id>
12929 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12930 -(((
12931 -(% class="western" %)
12932 -Get data for engagement id. The engagement id is a string
12933 -)))
12934 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12935 -(((
12936 -(% class="western" %)
12937 -POST
12938 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12939 -(((
12940 -(% class="western" %)
12941 -/(% style="color: rgb(33,33,33);" %)engagements
12942 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12943 -(((
12944 -(% class="western" %)
12945 -Create a new engagement
12821 +\\
12946 12946  
12947 -(% class="western" %)
12948 -Parameters required to create the engagement needs to be sent as post data in JSON format.
12949 -)))
12950 -(% class="" %)|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12951 -(((
12952 -(% class="western" %)
12953 -PUT
12954 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12955 -(((
12956 -(% class="western" %)
12957 -/(% style="color: rgb(33,33,33);" %)engagements(%%)/<engagement id>
12958 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12959 -(((
12960 -(% class="western" %)
12961 -Update engagement by engagement id. The engagement id string
12823 +\\
12962 12962  
12963 -(% class="western" %)
12964 -Parameters required to update the engagement needs to be sent as post data in JSON format.
12965 -)))
12966 -|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12967 -(((
12968 -(% class="western" %)
12969 -POST
12970 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12971 -(((
12972 -(% class="western" %)
12973 -(% style="color: rgb(33,33,33);" %)/engagements/addUser
12974 -)))|(% style="text-align: left;vertical-align: top;" %)(% style="text-align: left;vertical-align: top;" %)
12975 -(((
12976 -(% class="western" %)
12977 -Add user to engagement
12825 +\\
12978 12978  
12979 -(% class="western" %)
12980 -Parameters required to add user to the engagement needs to be sent as post data in JSON format.
12981 -)))
12827 +\\
12982 12982  
12983 12983  \\
12984 12984  
12985 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
12986 -== (% 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 Engagements(%%) ==
12831 +\\
12987 12987  
12988 -----
12833 +\\
12989 12989  
12990 -----
12835 +\\
12991 12991  
12992 -{{panel bgColor="#D3D3D3" width="100%"}}
12993 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements
12994 -{{/panel}}
12837 +\\
12995 12995  
12996 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
12839 +\\
12997 12997  
12998 -----
12841 +\\
12999 12999  
13000 -(% 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}}
12843 +\\
13001 13001  
13002 -==== Example ====
12845 +\\
13003 13003  
13004 -----
12847 +\\
13005 13005  
13006 -(% style="color: rgb(107,107,107);" %)Request
12849 +\\
13007 13007  
13008 -{{code language="php" theme="RDark" title="Get All Engagement Request" collapse="true"}}
13009 -<?php
12851 +\\
13010 13010  
13011 -$curl = curl_init();
12853 +\\
13012 13012  
13013 -curl_setopt_array($curl, array(
13014 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements',
13015 - CURLOPT_RETURNTRANSFER => true,
13016 - CURLOPT_ENCODING => '',
13017 - CURLOPT_MAXREDIRS => 10,
13018 - CURLOPT_TIMEOUT => 0,
13019 - CURLOPT_FOLLOWLOCATION => true,
13020 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13021 - CURLOPT_CUSTOMREQUEST => 'GET',
13022 - CURLOPT_HTTPHEADER => array(
13023 - 'Appkey: {{ONECOUNT API KEY}}'
13024 - ),
13025 -));
13026 -
13027 -$response = curl_exec($curl);
13028 -
13029 -curl_close($curl);
13030 -echo $response;
13031 -
13032 -
13033 -{{/code}}
13034 -
13035 13035  \\
13036 13036  
13037 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
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 -
13040 -----
13041 -
13042 -----
13043 -
13044 -{{panel bgColor="#D3D3D3" width="100%"}}
13045 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/~{~{Engagement ID}}
13046 -{{/panel}}
13047 -
13048 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13049 -
13050 -----
13051 -
13052 -(% 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}}
13053 -
13054 -==== Example ====
13055 -
13056 -----
13057 -
13058 -(% style="color: rgb(107,107,107);" %)Request
13059 -
13060 -{{code language="php" theme="RDark" title="Get Specific Engagement Request" collapse="true"}}
13061 -<?php
13062 -
13063 -$curl = curl_init();
13064 -
13065 -curl_setopt_array($curl, array(
13066 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/{{Engagement ID}}',
13067 - CURLOPT_RETURNTRANSFER => true,
13068 - CURLOPT_ENCODING => '',
13069 - CURLOPT_MAXREDIRS => 10,
13070 - CURLOPT_TIMEOUT => 0,
13071 - CURLOPT_FOLLOWLOCATION => true,
13072 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13073 - CURLOPT_CUSTOMREQUEST => 'GET',
13074 - CURLOPT_HTTPHEADER => array(
13075 - 'Appkey: {{ONECOUNT API KEY}}'
13076 - ),
13077 -));
13078 -
13079 -$response = curl_exec($curl);
13080 -
13081 -curl_close($curl);
13082 -echo $response;
13083 -
13084 -
13085 -{{/code}}
13086 -
13087 13087  \\
13088 13088  
13089 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
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 -
13092 -----
13093 -
13094 -{{panel bgColor="#D3D3D3" width="100%"}}
13095 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements
13096 -{{/panel}}
13097 -
13098 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13099 -
13100 -----
13101 -
13102 -(% 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}}
13103 -
13104 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13105 -
13106 -----
13107 -
13108 -{{code language="yml" theme="RDark" title="Body" collapse="true"}}
13109 -{"Name":"Engagement Name", "Description":"Engagement Description", "Metrics":[
13110 - {"Name":[{"webinar ID 1":"Webinar 1"},{"webinar ID 3":"Webinar 3"},{"webinar ID 3":"Webinar 3"}],"Type": "select"},
13111 - {"Attendance Status":[{"attended":"Attended"},{"not_attended":"Not Attended"}],"Type": "select"},
13112 - {"Price":[],"Type": "numeric"},
13113 - {"Transaction Date":[],"Type": "date"}
13114 -]}
13115 -{{/code}}
13116 -
13117 -==== Example ====
13118 -
13119 -----
13120 -
13121 -(% style="color: rgb(107,107,107);" %)Request
13122 -
13123 -{{code language="php" theme="RDark" title="Create Engagement Request" collapse="true"}}
13124 - <?php
13125 -
13126 -$curl = curl_init();
13127 -
13128 -curl_setopt_array($curl, array(
13129 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements',
13130 - CURLOPT_RETURNTRANSFER => true,
13131 - CURLOPT_ENCODING => '',
13132 - CURLOPT_MAXREDIRS => 10,
13133 - CURLOPT_TIMEOUT => 0,
13134 - CURLOPT_FOLLOWLOCATION => true,
13135 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"},
13140 - {"Price":[],"Type": "numeric"},
13141 - {"Transaction Date":[],"Type": "date"}
13142 -]}',
13143 - CURLOPT_HTTPHEADER => array(
13144 - 'Appkey: {{ONECOUNT API KEY}}'
13145 - ),
13146 -));
13147 -
13148 -$response = curl_exec($curl);
13149 -
13150 -curl_close($curl);
13151 -echo $response;
13152 -{{/code}}
13153 -
13154 13154  \\
13155 13155  
13156 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
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 -
13159 -----
13160 -
13161 -{{panel bgColor="#D3D3D3" width="100%"}}
13162 - (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/~{~{Engagement Id}}
13163 -{{/panel}}
13164 -
13165 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13166 -
13167 -----
13168 -
13169 -(% 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}}
13170 -
13171 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13172 -
13173 -----
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"},
13178 - {"Price":[],"Type": "text"}
13179 -]}
13180 -{{/code}}
13181 -
13182 -==== Example ====
13183 -
13184 -----
13185 -
13186 -(% style="color: rgb(107,107,107);" %)Request
13187 -
13188 -{{code language="php" theme="RDark" title="Update Engagement Request" collapse="true"}}
13189 - <?php
13190 -
13191 -$curl = curl_init();
13192 -
13193 -curl_setopt_array($curl, array(
13194 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/{{Engagement Id}}',
13195 - CURLOPT_RETURNTRANSFER => true,
13196 - CURLOPT_ENCODING => '',
13197 - CURLOPT_MAXREDIRS => 10,
13198 - CURLOPT_TIMEOUT => 0,
13199 - CURLOPT_FOLLOWLOCATION => true,
13200 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"},
13204 - {"Price":[],"Type": "text"}
13205 -]}',
13206 - CURLOPT_HTTPHEADER => array(
13207 - 'Appkey: {{ONECOUNT API KEY}}'
13208 - ),
13209 -));
13210 -
13211 -$response = curl_exec($curl);
13212 -
13213 -curl_close($curl);
13214 -echo $response;
13215 -{{/code}}
13216 -
13217 13217  \\
13218 13218  
13219 -(% style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
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 -
13222 -----
13223 -
13224 -{{panel bgColor="#D3D3D3" width="100%"}}
13225 -(% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color: rgb(33,33,33);" %)/engagements/addUser
13226 -{{/panel}}
13227 -
13228 -=== (% class="core-title" style="color: rgb(33,33,33);" %)Request Headers(%%) ===
13229 -
13230 -----
13231 -
13232 -(% 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}}
13233 -
13234 -=== (% style="color: rgb(33,33,33);" %)Body (% style="color: rgb(107,107,107);" %)raw (json)(%%) ===
13235 -
13236 -----
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"]}
13240 -{{/code}}
13241 -
13242 -==== Example ====
13243 -
13244 -----
13245 -
13246 -(% style="color: rgb(107,107,107);" %)Request
13247 -
13248 -{{code language="php" theme="RDark" title="Add User to Engagement Request" collapse="true"}}
13249 - <?php
13250 -
13251 -$curl = curl_init();
13252 -
13253 -curl_setopt_array($curl, array(
13254 - CURLOPT_URL => 'https://api.onecount.net/v2/engagements/addUser',
13255 - CURLOPT_RETURNTRANSFER => true,
13256 - CURLOPT_ENCODING => '',
13257 - CURLOPT_MAXREDIRS => 10,
13258 - CURLOPT_TIMEOUT => 0,
13259 - CURLOPT_FOLLOWLOCATION => true,
13260 - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"]}',
13263 - CURLOPT_HTTPHEADER => array(
13264 - 'Appkey: {{ONECOUNT API KEY}}'
13265 - ),
13266 -));
13267 -
13268 -$response = curl_exec($curl);
13269 -
13270 -curl_close($curl);
13271 -echo $response;
13272 -{{/code}}
13273 -
13274 13274  (% class="western" %)
13275 -=== **COMPONENT: Leads
13276 -** ===
12864 +**COMPONENT: Leads
12865 +**
13277 13277  
13278 13278  (% class="western" %)
13279 13279  Stats resource can be used to submit any type of stat collected on the third party systems. Each type of stat will be represented by a sub-resource. So, for telemarketing it could be **/stats/telemarketing** endpoint, for videos it can be **/stats/videos**, for webinar it could be **/stats/webinars** etc. Right now we only have telemarketing sub-resource.
... ... @@ -13458,6 +13458,14 @@
13458 13458  
13459 13459  \\
13460 13460  
13050 +\\
13051 +
13052 +\\
13053 +
13054 +\\
13055 +
13056 +\\
13057 +
13461 13461  (% class="western" %)
13462 13462  **API REFERENCE**
13463 13463  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -108265485
1 +108265483
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/108265483/ONEcount API Documentation