HomeAppVirality DocsAppVirality APIsRegister Conversion Event

Register Conversion Event

Registering or recording the completion of a Conversion Events – so as to allow the application of rules defined & generation of attribution analytics


Helps you record/register a Conversion Event

Every rule you define as a part of your campaign shall be tagged to a certain conversion event. This conversion event is actually the action taken by a user, which we have earmarked for incentivisation. These events need to be registered with AppVirality servers to enable full proof functionality.

While this is (and can) be done through the SDK, you may register conversion events over API calls i.e. from server side. You’ll need the Private Key & App User Key for this call.

Base URL  https://api.appvirality.com

 POST         /v2_0/registerconversionevent

Content-Type application/json


Input i.e. Request

{
    "apikey": "7ffdda00fd5c4338a9c1a44e00663648",
    "privatekey": "d1e881dc60fa4856be34a44f00d96c9a",
    "userkey": "588d87d8d9e89ac5d710caf68910ac5d",
    "EmailId": "",
    "UserIdInstore": "",
    "eventName": "Transaction",
    "extraInfo": "OrderID:22465,Ordernote:CashonDelivery",
    "transactionValue": "250.00",
    "transactionUnit": "$",<br>
    "tskey":"346553563792",
    "campaignId":"270",
    "growthHack":"Word_of_Mouth"
}
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
(conditional)
User Key for the App user – 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
eventName Name/Type of the Conversion Event: Install, Signup, Transaction or any custom defined event
transactionValue
(conditional)
Transaction amount
This value is must in case the reward is based on Transaction Amount
transactionUnit
(optional)
Transaction currency unit
extraInfo
(optional)
Custom Info which is stored across the event and will be provided back in web hook.
It is generally used to save transaction information which can be used to cross check later while rewarding. If the content has any special characters use Encoded URI format
tskey Unique Integer for an Event to avoid duplicate rewards upon retry
(Eg: Unix Timestamp 1453300397)
campaignId
(optional)
Unique ID of a campaign, generated by AppVirality
growthHack Type of Growth Hack
values: Word_of_Mouth or Loyalty_Program

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

 


Response

{
"success":true,
"statuscode": 1,
"message": success
}
Response Params
Output Params Description
success returns true on successful conversion
(i.e. Referrer/Friend gets rewarded)
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 Register Conversion Event API

Status codes and description for API responses
Status Code Description
1 Success
2 Invalid User Key
3 Invalid GrowthHack
4 Invalid CampaignID
5 Invalid StoreID or EmailID
18 Is an Existing User
43 No rewards for the user
46 Invalid event
47 Event already sent
48 Transaction amount is lessthan minimum transaction value
51 Referrer reached max limit
52 Referrer reached reward frequency
56 Friend reached reward frequency
58 User reached reward frequency
59 User reached max reward cap
65 Duplicate Event
67 User doesn't have a Referrer
68 User is Blocked / Suspicious
69 Campaign is not Active
71 No reward for referrer and friend
77 Event registered and will be processed shortly
Was this article helpful to you? Yes No