Introduction

Get metadata API returns metadata objects corresponding to a user, campaign and campaign_type. you can call this API at applicable touch points on your application to create customised UI page for a campaign using metadata configured in rehook.

API details

API Endpoint: https://api.rehook.ai/campaigns/meta-data

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.

Authentication

You need to provide the API key and Secret key of your application in every new request as Authorization. Rehook use 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

URL = https://api.rehook.ai/campaigns/meta-data

query parameters: empty

complete response

[
  {
    "campaign_id": "camp_EOurRUrHEDfTH5oo00pMp",
    "campaign_type": "leaderboard",
    "id": "",
    "campaign_status": "active"
  },
  {
    "campaign_id": "camp_8w7wPVVB2v0EK4PTCkrk5",
    "campaign_type": "camp_8w7wPVVB2v0EK4PTCkrk5",
    "id": "",
    "campaign_status": "active",
    "metadata": {
      "referral_banner_page": "image URL",
      "referal_ui_description": "refer a freiend and get 30 coins"
    }
    ]

Definition of response body

Response body is an array of objects. each array has campaign details with it's respective metadata. you have to consume the meta data object within a campaign array.

metadata object

Example:

API Behaviour

Below table shows the expected response for different cases

📘

Note

1. campaign_id is available on rehook dashboard against each campaign. you have to manually get this id from rehook dashboard only and map the same id at your end.
2. campaign type have following standard values - loyalty, referral, distribution, leaderboard
3. Don't pass any query parameters if you want to fetch all the campaign details

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

Following are possible list of cases with error messages

1. when source_id is wrong

reutrns all the campaigns details

2. when campaign_id or campaign type is wrong

[] empty response