Changes for page ONEcount API Documentation
Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 13.1
edited by Rayaan Ahmed
on 2025/02/03 18:55
on 2025/02/03 18:55
Change comment:
There is no comment for this version
To version 14.1
edited by Rayaan Ahmed
on 2025/02/09 21:08
on 2025/02/09 21:08
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -10135,7 +10135,97 @@ 10135 10135 } 10136 10136 {{/code}} 10137 10137 10138 +(% id="HGETspecificResource" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %) 10139 +== (% 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(%%) == 10138 10138 10141 +---- 10142 + 10143 + 10144 +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 10145 + 10146 +n = New subscription 10147 + 10148 +r = Renew subscription 10149 + 10150 +u = unsubscribe 10151 + 10152 +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. 10153 + 10154 +{{panel bgColor="#D3D3D3" width="100%"}} 10155 + (% class="nolink" %)https:~/~/api.onecount.net/v2(% style="color:#212121" %)/resources(%%)/analytics?type=~{~{Subscription Type}}&start_date=~{~{Start Date}} 10156 +{{/panel}} 10157 + 10158 +=== (% class="core-title" style="color:#212121" %)Request Headers(%%) === 10159 + 10160 +---- 10161 + 10162 +(% 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}} 10163 + 10164 +==== Example ==== 10165 + 10166 +---- 10167 + 10168 +(% style="color:#6b6b6b" %)Request 10169 + 10170 +{{code language="php" title="Get specific Resource Request"}} 10171 + <?php 10172 + 10173 +$curl = curl_init(); 10174 + 10175 +curl_setopt_array($curl, array( 10176 + CURLOPT_URL => ' https://api.onecount.net/v2/resources/analytics?type={{Subscription Type}}&start_date={{Start Date}}', 10177 + CURLOPT_RETURNTRANSFER => true, 10178 + CURLOPT_ENCODING => '', 10179 + CURLOPT_MAXREDIRS => 10, 10180 + CURLOPT_TIMEOUT => 0, 10181 + CURLOPT_FOLLOWLOCATION => true, 10182 + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 10183 + CURLOPT_CUSTOMREQUEST => 'GET', 10184 + CURLOPT_HTTPHEADER => array( 10185 + 'Appkey: {{ONECOUNT API KEY}}' 10186 + ), 10187 +)); 10188 + 10189 +$response = curl_exec($curl); 10190 + 10191 +curl_close($curl); 10192 +echo $response; 10193 +{{/code}} 10194 + 10195 + 10196 +(% style="color:#6b6b6b" %)Response 200 OK 10197 + 10198 +{{code language="yml" title="Get specific Resource Response"}} 10199 + { 10200 + "result": { 10201 + "success": "1", 10202 + "error": { 10203 + "code": "", 10204 + "message": "" 10205 + } 10206 + }, 10207 + "Resources": [ 10208 + "Resources Users": [ 10209 + { 10210 + "resource_uid": "11462", 10211 + "ocid": 74204991, 10212 + "request_date": 20250118 10213 + }, 10214 + { 10215 + "resource_uid": "11462", 10216 + "ocid": 121746390, 10217 + "request_date": 20250118 10218 + }, 10219 + { 10220 + "resource_uid": "11462", 10221 + "ocid": 45412583, 10222 + "request_date": 20250118 10223 + } 10224 + ] 10225 +} 10226 +{{/code}} 10227 + 10228 + 10139 10139 (% id="HCOMPONENT:SourceCodes" class="western" %) 10140 10140 === **COMPONENT: Source Codes** === 10141 10141 ... ... @@ -15303,7 +15303,6 @@ 15303 15303 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. 15304 15304 ))) 15305 15305 15306 - 15307 15307 **Example 1: How to use API to unsubscribe user from package if you don't have a package ID or term ID** 15308 15308 15309 15309 **~1. Get all packages using below API call**