HomeAppVirality DocsAppVirality APIsFind Merged Users

Find Merged Users

This api will allow you to fetch the users information who got merged.

 

This API call allows you to obtain some critical info about the users merged based on the same emailid. Things like user’s email, advertising ID, username, referrer code, etc. could be warranted at various points inside the app during a user’s active experience. This API offers you just that.

Base URL  https://api.appvirality.com

 POST         /v2_0/findmergedusers

Content-Type application/json

Input i.e. Request

{
"apikey":"7b808b1f969048db8463a4c60091c49b",
"privatekey":"09726325ed71465191eda4ec006d601b",
"EmailId":"test@test.com",
"userkey":"",
"UserIdInstore":""
}

 

Input Params
Input Params Description
apikey API Key of the App
Get it from Dashboard >> App Details
privatekey Private key for API requests
Get it from: Dashboard >> App Details >> Click App Settings >> Scroll down to Advanced Settings
userkey
User Key for the an App user (helps you filter the users which were merged with the user)
EmailId
 
Email of the User (helps you filter the users which were merged with the user)
UserIdInstore
(conditional)
Store Id of the App user, updated to AppVirality – a unique identifier of the user in your App

you should provide either Userkey or Emailid.

Response:

 

{
    "users": [
        {
            "userkey": "a5208a5aca6f4050918f2f2b14d2867b",
            "mergekey": "aafeb4f718d643f5aeada6250066131d",
            "deviceId": "00test000test066b2aa5fabfbd513",
            "EmailId": "test@test.com",
            "DeviceAdvertisingId": null,
            "AppUserName": "MYT",
            "FriendReferralCode": null,
            "ReferralCode": "2eyp",
            "UserIdInstore": "1367",
            "updatedemails": [
                {
                    "emailid": "test@test.com",
                    "updateddate": "9-Dec-2016 7:30:17"
                }
            ]
        },
        {
            "userkey": "ddf79caa9b2d4637be9a724748c61383",
            "mergekey": "aafeb4f718d643f5aeada6250066131d",
            "deviceId": "00test000test05aed9248ede58ae3",
            "EmailId": "test@test.com",
            "DeviceAdvertisingId": null,
            "AppUserName": "MYT",
            "FriendReferralCode": "2f37",
            "ReferralCode": "2f5z",
            "UserIdInstore": "1367",
            "updatedemails": [
                {
                    "emailid": "test@test.com",
                    "updateddate": "9-Dec-2016 7:30:17"
                }
            ]
        }
    ],
    "success": true,
    "statuscode": 1,
    "message": "Success"
}


NOTE

~ preceding a parameter e.g. ~ updateddate, implies the param is a nested/subset of the most recent non-tilde param, i.e. in this case updateddate is a sub/nested param under updatedemails

Response Params
Output Params Description
userkey User Key for the an App user, assigned by AppVirality – a unique identifier for every App User recorded
Mergekey Key to identify the merged users
deviceId Unique ID assigned to a device
EmailId Email of the User
DeviceAdvertisingId Advertising ID assigned to Device by Google/Apple
AppUserName Name of the User
FriendReferralCode Friend's Referral Code i.e. the Referral code punched in by the user during his signup process
ReferralCode User's Referral Code
UserIdInstore ID of the user in your App
(helps to identify users on dashboard as you do in your app)
success Call Success Response (true/false)
message Information regarding API call (if relevant)
status code code based on status of the API call
updatedemails List of merged emails
~ EmailId Merged Email
~ updateddate Date of Email first update to AppVirality

Status codes which you will see while using Find Merged Users API

Status codes and description for API responses
Status Code Description
0 No data found for the search criteria
1 Success
2 Invalid User Key
5 Invalid StoreID or EmailID
Was this article helpful to you? Yes No