Introduction

This API enable you to know the reward progress of a customer for action based or referral campaign against it's target actions to be achieved by a customer to get the applicable reward.

for example: Get 100 points on placing 10 successful orders. customer gets reward when they completed 10 order_success event. In this case target action is 10 orders and number of order placed will be completed tasks.

API details

API Endpoint: https://api.rehook.ai/campaigns/reward-progress

HTTP Method: GET

Prerequisites

1. API Key and Secret Key for your application
2. If you don't know the API key and secret key, please go to setting module on admin panel to view API details for your application. To know more about application setting, please visit Application setting
3. API key and secret key are auto generated and cannot be changed.
4. Configure campaigns.

Limitations

1. Reward progress API is applicable for only referral campaign and action based campaign
2. Reward progress details will be available for following action types - 'Real time actions' and 'Actions with time'

Authentication

You need to provide the API key and Secret key of your application in every new request as Authorization. Rehook uses Basic authentication method to authenticate the API calls.

Parameters

query parameters

You have to provide following query parameters.

Body Parameters

This API doesn't requires any body parameters.

Sample request and response

request

URL = https://api.rehook.ai/campaigns/reward-progress

query parameters:

response - for real time actions

Response body will have array of objects. each array has the campaign details participated by a given customer and it's reward progress details.

{
        "campaign_id": "camp_1I7vOuIsPbyL4fB0Kck2K",
        "campaign_name": "Real time action campaign",
        "campaign_type": "loyalty",
        "rules": [
            {
                "rule_id": "valr_P8lM0Vag8l2Z5CpnMhNo4",
                "rule_name": "Rule 1",
                "action_type": "RTA",
                "actions": [
                    {
                        "event_id": "even_zPE2bLkbUH80jc663ep6E",
                        "event_name": "money_deposited",
                        "progress": 50,
                        "trigger": false,
                        "status": "active",
                        "current": 500,
                        "target": 1000
                    },
                    {
                        "event_id": "even_BZswDL0TV4ZRuiuoy7RmP",
                        "event_name": "order_success",
                        "progress":100,
                        "trigger": false,
                        "status": "completed",
                        "current":1,
                        "target": 1
                    }
                ]
            },
            {
                "rule_id": "valr_DgUrJ2lIFm1WsaqEMkHzZ",
                "rule_name": "Rule 2",
                "action_type": "RTA",
                "actions": [
                    {
                        "event_id": "even_zPE2bLkbUH80jc663ep6E",
                        "event_name": "complete_KYC_Verification",
                        "progress": 0,
                        "trigger": false,
                        "status": "active",
                        "current": 0,
                        "target": 1
                    }
                ]
            }
        ]
    }
]

Definition of response

Without object

Rules object (for action type = Real time actions)

📘

Example: Real time actions

Rule definition:

Rule 1 --> event 1: make a deposit of cumulative amount of $1000.AND event 2: Complete your first
purchase

Rule 2 --> Complete your KYC verification and Get 100 loyalty points

Progress

Rule	event	Target	Current	Progress
Rule1	event1	$1000 as user have to make a cumulative deposit amount of $1000	$500	50% as user have completed only $500 of target value $1000
Rule1	event2	1 as user has to make only one purchase	1	100% as user have completed the first purchase
Rule2	event1	1 as user has to complete the KYC verification only 1 time	0	0% as user have not completed the KYC verification

response - Actions with time

{
        "campaign_id": "camp_D01sluPJ3NBv82cpWQbs1",
        "campaign_name": "Action with time",
        "campaign_type": "loyalty",
        "rules": [
            {
                "rule_id": "valr_2mvsVY2amxKjgZxuwQzKo",
                "rule_name": "Place a min order worth of $200 within 2 days of signup and get a 20% coupon",
                "action_type": "AWT",
                "actions": [
                    {
                        "event_id": "even_WoPKAqCWhTOkJ2UGLRLbS",
                        "event_name": "signup",
                        "progress": 100,
                        "trigger": true,
                        "status": "completed",
                        "current": 1,
                        "target": 1,
                        "start_time": 1708664771
                    },
                    {
                        "event_id": "even_zPE2bLkbUH80jc663ep6E",
                        "event_name": "order_success",
                        "progress": 100,
                        "trigger": false,
                        "status": "completed",
                        "current": 1,
                        "target": 1,
                        "start_time": 1708664771,
                        "end_time": 1708837571,
                        "time_duration": 172800,
                        "time_left": 172784
                    }
                ]
            }
        ]
    }

Rules object (for action type = Actions with time)

📘

Example: Actions with time

Rule definition

place a min order worth of $200 within 2 days of signup and get 0% coupon

Event X (Benchmark event): signup

Event Y (Trigger event): order_success

Rule timer:

System will start the timer when signup event is received and user is expected to complete the order_success event within 2 days from start_time of event X

Rule progress

Event	Target	Current	Timer	Progress
signup (event X)	1	1	start_time: 1708664771 signup is completed on 21st feb	100% as user have completed the event X
order_success (event Y)	1	1	start_time: same as event x end_time: 1708837571 time_duration: 172800 time_left: 172784	100% as user have completed the event Y within 2 days of signup.

Success Response:

If API call is successful, then Rehook will return the following HTTP success code with response body as given above.

Error Responses

If API call is failed, then Rehook will return the following HTTP success code with response body as given below:

error response body

**when source_id is wrong or not passed in the URL

{
  "code": 404,
  "key": "not_found",
  "message": "Resource not found",
  "details": "Cannot find customer with source id source_id",
  "request_id": "9c0003f4-0443-9101-bb13-245b8ddd0070"
}