Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 15.1
edited by Rayaan Ahmed
on 2025/02/09 22:20
Change comment: There is no comment for this version
To version 12.1
edited by Admin User
on 2024/04/29 14:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.rayaan
1 +XWiki.admin
Content
... ... @@ -10135,97 +10135,7 @@
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(%%) ==
10140 10140  
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 users, resource id and request date based on subscription type and start date"}}
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 users, resource id and request date based on subscription type and start date"}}
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 -
10229 10229  (% id="HCOMPONENT:SourceCodes" class="western" %)
10230 10230  === **COMPONENT: Source Codes** ===
10231 10231  
... ... @@ -15392,138 +15392,3 @@
15392 15392  (% class="western" %)
15393 15393  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.
15394 15394  )))
15395 -
15396 -**Example 1: How to use API  to get users who unsubscribed to resources in past 1 day and unsubscribe them to a package**
15397 -
15398 -**~1. Get all packages using below API call**
15399 -
15400 -[[https:~~/~~/api.onecount.net/v2/products?limit=10000>>url:https://api.onecount.net/v2/products?limit=10000]]
15401 -\\This will give all the packages with all the resources attached to that package below is sample response.
15402 -
15403 -
15404 -[
15405 -
15406 - {
15407 -
15408 - "ProductId": 2374,
15409 -
15410 - "Title": "OptL-0- ENTECH EVENT-VSL Virtual Seminars",
15411 -
15412 - "Description": "",
15413 -
15414 - "ResourceIDs": [
15415 -
15416 - 16366,
15417 -
15418 - 16374,
15419 -
15420 - 16638,
15421 -
15422 - 16646,
15423 -
15424 - 17030,
15425 -
15426 - 17038,
15427 -
15428 - 17046,
15429 -
15430 - 17054
15431 -
15432 - ],
15433 -
15434 - "PrimaryFormID": [
15435 -
15436 - "251fc466-0f68-483d-afa6-1b05cb3ae9b0"
15437 -
15438 - ],
15439 -
15440 - "Terms": {
15441 -
15442 - "Id": 2462,
15443 -
15444 - "Name": "Active",
15445 -
15446 - "Description": "",
15447 -
15448 - "Duration": 1,
15449 -
15450 - "DurationUnit": "D",
15451 -
15452 - "Price": "0",
15453 -
15454 - "ProductId": 2374
15455 -
15456 - }
15457 -
15458 - }
15459 -
15460 -]
15461 -
15462 -
15463 -FYI : ResourceIDs are product ids
15464 -
15465 -Productid is package id
15466 -\\If your desired resource is in the package then use the product id and term id to unsubscribe user from that package
15467 -
15468 -**2. Get all the users who unsubscribed to resources in past 1 day**
15469 -
15470 -use below API to get all user who unsubscribed to resources in past 1 day
15471 -
15472 -[[http:~~/~~/api.onecount.net/v2/resources/analytics?type=u&start_date=20250>>url:http://api.onecount.net/v2/resources/analytics?type=u&start_date=20250110]]209
15473 -
15474 -Below is the sample response :
15475 -
15476 -{
15477 -
15478 -"result": {
15479 -
15480 - "success": "1",
15481 -
15482 - "error": {
15483 -
15484 - "code": "",
15485 -
15486 - "message": ""
15487 -
15488 - }
15489 -
15490 - },
15491 -
15492 -"Resources Users": [
15493 -
15494 -{
15495 -
15496 -"resource_uid": "11462",
15497 -
15498 -"ocid": 74204991,
15499 -
15500 -"request_date": 20250118
15501 -
15502 -},
15503 -
15504 -{
15505 -
15506 -"resource_uid": "11462",
15507 -
15508 -"ocid": 121746390,
15509 -
15510 -"request_date": 20250118
15511 -
15512 -}
15513 -
15514 -]
15515 -
15516 -}
15517 -
15518 -FYI:
15519 -ocid = userid
15520 -
15521 -
15522 -**3. Use user, product id and term id  from the response above to unsubscribe user from the package**
15523 -\\Use this API and body to unsubscribe users
15524 -\\[[https:~~/~~/api.onecount.net/v2/transactions>>url:https://api.onecount.net/v2/transactions]]
15525 -\\**BODY:**
15526 -{"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" }
15527 -\\This will unsubscribe user from that package
15528 -
15529 -