HomeAppVirality DocsAppVirality APIsGet App User Details

Get App User Details

Allows you to extract all details of a user in your App, as captured & maintained by AppVirality


This API call allows you to obtain some critical info points regarding an app user. 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/getappuserdetails

Content-Type application/json


Input i.e. Request

{
"userkey":"588d87d8d9e89ac5d710caf68910ac5d",
"apikey":"7ffdda00fd5c4338a9c1a44e00663648",
"privatekey":"d1e881dc60fa4856be34a44f00d96c9a",
"EmailId": "",
"UserIdInstore": "",
}
Input Params
Input Params Description
apikey API Key of the App
Get it from Dashboard >> App Details
userkey
(conditional)
User Key for the an App user, assigned by AppVirality – a unique identifier for every App User recorded
EmailId
(conditional)
Email of the User, updated to AppVirality
UserIdInstore
(conditional)
Store Id of the App user, updated to AppVirality – a unique identifier of the user in your App
privatekey Private key for API requests
Get it from: Dashboard >> App Details >> Click App Settings >> Scroll down to Advanced Settings

conditional – One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId


Response

{
  "userkey": "588d87d8d9e89ac5d710caf68910ac5d",
  "deviceId": "00test0576890325442",
  "EmailId": null,
  "DeviceAdvertisingId": "7ebddcbf-50f0-4bd7-a271-b106648117b8",
  "AppUserName": "test210752name",
  "FriendReferralCode": "2def",
  "ReferralCode": "2der",
  "UserIdInstore": null,
  "success": true,
  "statuscode": 1,
  "message": success
}
Response Params
Output Params Description
userkey User Key for the an App user, assigned by AppVirality – a unique identifier for every App User recorded
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)
status code code based on status of the API call
message Information regarding API call (if relevant)

Status codes which you will see while using Get App User Details 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 1 No