Changes for page ONEcount API Documentation

Last modified by Rayaan Ahmed on 2025/02/09 22:20

From 9.1 to 10.1 From 14.1 to 15.1

From version 10.1

edited by Rayaan Ahmed
on 2024/02/27 18:43

Change comment: There is no comment for this version

To version 14.1

edited by Rayaan Ahmed
on 2025/02/09 22:08

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -58,6 +58,7 @@
 . Get specific engagement by engagement id
 . Create Engagements
 . Update Engagements
++11. Add options to metric for an engagement
 . Add users data to Engagement
 . Segments
 . Get all Segments
@@ -147,13 +147,13 @@
  === **COMPONENT: Users** ===
  (% class="western" %)
--Users means the customers of your system. Users can be added, updated and searched for using the users resource from the api. For lookup, If a return parameter is specified Users object will have those fields. If nothing is specified by default only UserId is returned.
++Users means the customers of your system. Users can be added, updated and searched for using the users resource from the api. For lookup, If a return parameter is specified Users JSON object will have those fields. If nothing is specified by default only UserId is returned.
  (% class="western" %)
  Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added.
  (% class="western" %)
--In this case the provided demographic information in users object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated.
++In this case the provided demographic information in users JSON object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated.
  (% class="western" %)
  If username and password is not one of the parameters being passed, then a random username and password will be generated for the user while creating his user account in ONEcount.
@@ -235,7 +235,25 @@
  Create a new users
  (% class="western" %)
--Parameters required to create the user needs to be sent as post data in JSON format.
++Parameters required to create the user needs to be sent as post data in JSON format. Below is the example of data
++\\Example:
++
++(% class="western" %)
++{"Users":{"PartnerId":1,"Demo":{"1":"rayaan@onecount.net","4":"Rayaan","5":"Ahmed"}},"DedupeColumns":"1","Transactions":[],"Return":"4,5,1"}
++
++
++(% class="western" %)
++1) PartherId is required, this can be any integer value.
++
++(% class="western" %)
++2) Demo is required it contains JSON object of user demographic information key as demo id and value as actual information of user.
++
++(% class="western" %)
++3) DedupeColumn is required, this contains demo id as value, used to check duplicate user based on demo id.
++
++(% class="western" %)
++4) Transactions is required, If user does not have any transaction pass empty array if user has a transaction pass transaction JSON object. please refer transaction API body for JSON object.
++
  )))
  |(% style="text-align:left; vertical-align:top" %)(% style="text-align: left;vertical-align: top;" %)
  (((
@@ -311,10 +311,6 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
--(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
--{{/panel}}
--
  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
  ----
@@ -849,12 +849,6 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
-- (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/(% style="color:#212121" %)~{~{OCID}}
--{{/panel}}
--
--=== (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
--
  ----
  (% class="Text__TextContainer-sc-1kqigik-0 cEvDCP iauueY item-key sc-fznXWL" style="color:#212121" %)Appkey                                                                                                 (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color:#212121" %)~{~{ONECOUNT API KEY}}
@@ -947,10 +947,6 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
-- (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users(% class="nolink" style="color:#212121" %)/login
--{{/panel}}
--
  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
  ----
@@ -1021,10 +1021,6 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
--(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users(% class="nolink" style="color:#212121" %)/lookup?2=user_242_6298&return=1,2,3,4
--{{/panel}}
--
  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
  ----
@@ -1101,10 +1101,6 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
--(% class="nolink nolink" %)https:~/~/api.onecount.net/v2(% class="nolink" style="color:#212121" %)/users/~{~{OCID}}/partners/~{~{Partner id}}
--{{/panel}}
--
  === (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
  ----
@@ -1116,11 +1116,7 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
--(% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users
--{{/panel}}
--
  (% class="western" %)
  **POST method should be used to create users.**
@@ -1149,7 +1149,7 @@
  )))|(% style="text-align:left; vertical-align:top" %)(% style="text-align: left;vertical-align: top;" %)
  (((
  (% class="western" %)
--Users object that contains information about user to create. PartnerId Needs to be specified.
++Users object that contains information about user to create. PartnerId Needs to be specified. PartnerId is any integer value.
  )))
  |(% style="text-align:left; vertical-align:top" %)(% style="text-align: left;vertical-align: top;" %)
  (((
@@ -1289,11 +1289,7 @@
  ----
--{{panel bgColor="#D3D3D3" width="100%"}}
-- (% class="nolink nolink" %)https:~/~/api.onecount.net/v2/users/~{~{OCID(% class="nolink" %)}}
--{{/panel}}
--
  (% class="western" %)
  **PUT method should be used to update users.**
@@ -1621,6 +1621,9 @@
  (% class="western" %)
  JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
++
++(% class="western" %)
++NOTE: While updating a select and checkbox type question you need to pass complete set of Choices for that question including the one which are already existing. If not the choices will be overwritten from the choices from the body.
  )))
  (% id="HGETAllQuestions" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
@@ -8136,8 +8136,9 @@
  (% id="HPUTUpdatequestion" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
  == (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#0053b8" %)PUT (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)Update question(%%) ==
------
++NOTE: While updating a select and checkbox type question you need to pass complete set of Choices for that question including the one which are already existing. If not the choices will be overwritten from the choices from the body.
++
  {{panel bgColor="#D3D3D3" width="100%"}}
   (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color:#212121" %)/questions/~{~{QUESTION ID}}
  {{/panel}}
@@ -10142,7 +10142,97 @@
  }
  {{/code}}
++(% id="HGETspecificResource" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
++== (% class="imuBmi sc-fzoaKM" id="cke_bm_37074S" style="color:#007f31; display:none" %) (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET(% class="imuBmi sc-fzoaKM" style="color:#212121" %) users, resource id and request date based on subscription type and start date(%%) ==
++----
++
++
++This API will pull all the users, resource id and request date based on subscription type and start date. There are 3 types of subscription type (n, r, u) where
++
++n = New subscription
++
++r = Renew subscription
++
++u = unsubscribe
++
++start date is used to pull users who has subscription activity from the start date to current date(todays date) you can go only past 30days as a start date.
++
++{{panel bgColor="#D3D3D3" width="100%"}}
++ (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color:#212121" %)/resources(%%)/analytics?type=~{~{Subscription Type}}&start_date=~{~{Start Date}}
++{{/panel}}
++
++=== (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
++
++----
++
++(% class="Text__TextContainer-sc-1kqigik-0 cEvDCP iauueY item-key sc-fznXWL" style="color:#212121" %)Appkey                                                                                                 (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color:#212121" %)~{~{ONECOUNT API KEY}}
++
++==== Example ====
++
++----
++
++(% style="color:#6b6b6b" %)Request
++
++{{code language="php" title="Get specific Resource Request"}}
++ <?php
++
++$curl = curl_init();
++
++curl_setopt_array($curl, array(
++  CURLOPT_URL => ' https://api.onecount.net/v2/resources/analytics?type={{Subscription Type}}&start_date={{Start Date}}',
++  CURLOPT_RETURNTRANSFER => true,
++  CURLOPT_ENCODING => '',
++  CURLOPT_MAXREDIRS => 10,
++  CURLOPT_TIMEOUT => 0,
++  CURLOPT_FOLLOWLOCATION => true,
++  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
++  CURLOPT_CUSTOMREQUEST => 'GET',
++  CURLOPT_HTTPHEADER => array(
++    'Appkey: {{ONECOUNT API KEY}}'
++  ),
++));
++
++$response = curl_exec($curl);
++
++curl_close($curl);
++echo $response;
++{{/code}}
++
++
++(% style="color:#6b6b6b" %)Response                                                                                                                                                                                                                                                                                                                                                                       200 OK
++
++{{code language="yml" title="Get specific Resource Response"}}
++ {
++    "result": {
++        "success": "1",
++        "error": {
++            "code": "",
++            "message": ""
++        }
++    },
++    "Resources": [
++        "Resources Users": [
++        {
++            "resource_uid": "11462",
++            "ocid": 74204991,
++            "request_date": 20250118
++        },
++        {
++            "resource_uid": "11462",
++            "ocid": 121746390,
++            "request_date": 20250118
++        },
++        {
++            "resource_uid": "11462",
++            "ocid": 45412583,
++            "request_date": 20250118
++        }
++    ]
++}
++{{/code}}
++
++
  (% id="HCOMPONENT:SourceCodes" class="western" %)
  === **COMPONENT: Source Codes** ===
@@ -12868,7 +12868,16 @@
  (% class="western" %)
  Parameters required to update the engagement needs to be sent as post data in JSON format.
++
++(% class="western" %)
++NOTE: While updating a select and checkbox type question you need to pass complete set of Choices for that question including the one which are already existing. If not the choices will be overwritten from the choices from the body.
  )))
++|(% style="text-align:left; vertical-align:top" %)POST|(% style="text-align:left; vertical-align:top" %)/engagements/metric/<engagement id>|(% style="text-align:left; vertical-align:top" %)(((
++Add options to specific metric in an engagement without passing all options and overriding existing options.
++
++Parameters required to update the engagement needs to be sent as post data in JSON format.
++\\This API is used to add options only for select and checkbox metrics.
++)))
  |(% style="text-align:left; vertical-align:top" %)(% style="text-align: left;vertical-align: top;" %)
  (((
  (% class="western" %)
@@ -13345,6 +13345,149 @@
  {{/code}}
++(% id="HPUTUpdateEngagement" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
++== (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" id="cke_bm_7146126S" style="color:#0053b8; display:none" %) (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#ad7a03" %)POST(% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#0053b8" %) (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)Add options to metric(%%) ==
++
++----
++
++{{panel bgColor="#D3D3D3" width="100%"}}
++ (% class="nolink" %)https:~/~/api.onecount.net/v2(%%)/engagements/metric/(% style="color:#212121" %)~{~{Engagement Id}}
++{{/panel}}
++
++=== (% class="core-title" style="color:#212121" %)Request Headers(%%) ===
++
++----
++
++(% class="Text__TextContainer-sc-1kqigik-0 cEvDCP iauueY item-key sc-fznXWL" style="color:#212121" %)Appkey                                                                                                 (% class="Text__TextContainer-sc-1kqigik-0 iYynAw" style="color:#212121" %)~{~{ONECOUNT API KEY}}
++
++=== (% style="color:#212121" %)Body (% style="color:#6b6b6b" %)raw (json)(%%) ===
++
++----
++
++{{code language="yml" title="Body"}}
++{"Metrics":[
++    {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
++    {"lagacy status":[{"text":"c","value":"c"}]}
++    ]}
++{{/code}}
++
++==== Example ====
++
++----
++
++(% style="color:#6b6b6b" %)Request
++
++{{code language="php" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
++ <?php
++
++$curl = curl_init();
++
++curl_setopt_array($curl, array(
++  CURLOPT_URL => 'https://api.onecount.net/v2/engagements/metric/{{Engagement Id}}',
++  CURLOPT_RETURNTRANSFER => true,
++  CURLOPT_ENCODING => '',
++  CURLOPT_MAXREDIRS => 10,
++  CURLOPT_TIMEOUT => 0,
++  CURLOPT_FOLLOWLOCATION => true,
++  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
++  CURLOPT_CUSTOMREQUEST => 'PUT',
++  CURLOPT_POSTFIELDS =>'{"Metrics":[
++    {"Attendance Status":[{"text":"checks","value":"checks"},{"text":"c","value":"c"}]},
++    {"lagacy status":[{"text":"c","value":"c"}]}
++    ]}',
++  CURLOPT_HTTPHEADER => array(
++    'Appkey: {{ONECOUNT API KEY}}',
++    'Content-Type: application/json'
++  ),
++));
++
++$response = curl_exec($curl);
++
++curl_close($curl);
++echo $response;
++
++{{/code}}
++
++
++(% style="color:#6b6b6b" %)Response                                                                                                                                                                                                                                                                                                                                                                       200 OK
++
++{{code language="yml" title="(% class=~"documentation-core-item-request-name jbmEtY sc-fzomuh~" style=~"color:#212121~" %)Add options to metric"}}
++{
++    "result": {
++        "success": "1",
++        "error": {
++            "code": "",
++            "message": ""
++        }
++    },
++    "Engagements": [
++        {
++            "Id": "e0e816ec-77ba-4db1-bfc0-22d340337357",
++            "Name": "Test engagement 3",
++            "Metrics": [
++                {
++                    "Name": "Attendance Status",
++                    "Type": "select",
++                    "Values": [
++                        {
++                            "text": "Attended",
++                            "value": "attended"
++                        },
++                        {
++                            "text": "Not Attended",
++                            "value": "not_attended"
++                        },
++                        {
++                            "text":"checks",
++                            "value":"checks"
++                        },
++                        {
++                            "text":"c",
++                            "value":"c"
++                        }
++                    ]
++                },
++                {
++                    "Name": "Price",
++                    "Type": "text"
++                },
++                {
++                    "Name": "Name",
++                    "Type": "select",
++                    "Values": [
++                        {
++                            "text": "Webinar 1",
++                            "value": "Webinar_1"
++                        },
++                        {
++                            "text": "Webinar 2",
++                            "value": "Webinar_2"
++                        }
++                    ]
++                },
++                {
++                    "Name": "Transaction Date",
++                    "Type": "text"
++                },
++                {
++                    "Name": "id",
++                    "Type": "text"
++                },
++                {
++                    "Name": "activity_time",
++                    "Type": "text"
++                }
++            ]
++        }
++    ]
++}
++{{/code}}
++
++
++
++
++
++
  (% id="HPOSTAddUsertoEngagement" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
  == (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#ad7a03" %)POST(% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %) Add User to Engagement(%%) ==
@@ -14253,7 +14253,6 @@
  Alias for admin purpose.
  )))
--
  (% class="western" %)
  **Type: Choices**
@@ -15159,3 +15159,83 @@
  If the page url already exists and it doesn't match with the one that is being sent then it will throw conflict error with the title in our system.
  )))
++**Example 1: How to use API  to unsubscribe user from package if you don't have a package ID or term ID**
++
++**~1. Get all packages using below API call**
++
++[[https:~~/~~/api.onecount.net/v2/products?limit=10000>>url:https://api.onecount.net/v2/products?limit=10000]]
++\\This will give all the packages with all the resources attached to that package below is sample response.
++
++
++[
++
++      {
++
++            "ProductId": 2374,
++
++            "Title": "OptL-0- ENTECH EVENT-VSL Virtual Seminars",
++
++            "Description": "",
++
++            "ResourceIDs": [
++
++                16366,
++
++                16374,
++
++                16638,
++
++                16646,
++
++                17030,
++
++                17038,
++
++                17046,
++
++                17054
++
++            ],
++
++            "PrimaryFormID": [
++
++                "251fc466-0f68-483d-afa6-1b05cb3ae9b0"
++
++            ],
++
++            "Terms": {
++
++                "Id": 2462,
++
++                "Name": "Active",
++
++                "Description": "",
++
++                "Duration": 1,
++
++                "DurationUnit": "D",
++
++                "Price": "0",
++
++                "ProductId": 2374
++
++            }
++
++        }
++
++]
++
++
++FYI : ResourceIDs are product ids
++
++Productid is package id
++\\If your desired resource is in the package then use the product id and term id to unsubscribe user from that package
++
++**2. Use product id and term id  from the response above to unsubscribe user from the package**
++\\Use this API and body to unsubscribe users
++\\[[https:~~/~~/api.onecount.net/v2/transactions>>url:https://api.onecount.net/v2/transactions]]
++\\**BODY:**
++{"UserId": 126715990,"TermId":2462,"UserIP":"192.168.0.1" ,"SubscriptionType":"u" , "ProductId":2374 ,"ResourceId":0,"FormId": "","Source": 39,"ProductStatus": 2,"Amount":"0.00" ,"PaypalTransId":"" , "MediaFilePath":"" ,"Remarks": "USER UNSUBSCRIBED FROM API","BatchId":"1234" ,"Quantity": 1, "ExpireDate":"20260115" }
++\\\\This will unsubscribe user from that package
++
++