Get Campaign Configurations

GET 
https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign

Retrieves detailed cashback conditions and configurations for the merchant's specific campaign. This includes maximum payable amounts, time schedules, applicable payment methods, campaign status, and cashback tiers with specific conditions and values. Useful for merchants to understand the parameters of their cashback campaigns and adjust their strategies accordingly.

Request

Query Parameters

page integer
The page number to retrieve in the paginated response. Defaults to 1 if not specified.
Default value: 1
Example: 1
per_page integer
The number of campaigns to display per page. Defaults to 10 if not specified.
Default value: 10
Example: 10
status string
Filter the campaigns by their status.
Example: active

Responses

200

A successful response containing cashback conditions and configurations.

application/json

Schema

Schema

merchant_idinteger
The unique identifier of the merchant associated with the campaign.
Example: 123
site_idstring
The unique identifier of the site where the campaign is active.
Example: site_123
campaign_idstring
The unique identifier of the cashback campaign.
Example: campaign_456
namestring
The name of the cashback campaign.
Example: Holiday Cashback Campaign
max_payable_cashback_amount object
Specifies maximum cashback amounts that can be paid out.
in_whole_campaign_durationnumbernullable
The maximum total cashback amount available for the entire campaign duration. Null indicates unlimited cashback.
Example: null
per_transactionnumbernullable
The maximum cashback amount that can be awarded per transaction. Null indicates no per-transaction limit.
Example: 50
max_cashback_amount_receivable_per_usernumbernullable
The maximum cashback amount each user can receive throughout the entire campaign. Null indicates no per-user limit.
Example: 200
time_schedule_response object
The time schedule for the campaign, including start and end times, and any repeating schedule.
start_timedate-time
The start time of the campaign in ISO 8601 format.
Example: 2024-11-05T16:20:00.000Z
end_timedate-time
The end time of the campaign in ISO 8601 format.
Example: 2024-12-05T16:20:00.000Z
start_time_repeatstringnullable
The start time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule.
Example: null
end_time_repeatstringnullable
The end time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule.
Example: null
repeat_daysstring[]nullable
An array of days of the week on which the campaign repeats. Null if the campaign does not repeat.
Example: ["Mon","Wed","Fri"]
payment_methodsstring[]
A list of payment methods that are valid for the cashback program.
Example: ["pay_id","pay_to","card"]
statusstring
The current status of the campaign.
Example: active
tiers object[]
A list of cashback tiers within the campaign, each defining specific cashback conditions and rewards.
Array [
cashback_typestring
The type of cashback ('percentage' or 'fixed') offered in this tier.
Example: percentage
cashback_valuenumber
The cashback value for this tier. For 'percentage' type, this represents a percentage (e.g., 10.0 for 10%). For 'fixed', this is a fixed monetary amount.
Example: 10
absolute_typestring
The condition type that must be met to qualify for cashback in this tier.
Example: min_order
absolute_valuenumber
The absolute value required to meet the cashback condition specified by 'absolute_type'.
Example: 100
]

Example (auto)

{
  "merchant_id": 123,
  "site_id": "site_123",
  "campaign_id": "campaign_456",
  "name": "Holiday Cashback Campaign",
  "max_payable_cashback_amount": {
    "in_whole_campaign_duration": null,
    "per_transaction": 50
  },
  "max_cashback_amount_receivable_per_user": 200,
  "time_schedule_response": {
    "start_time": "2024-11-05T16:20:00.000Z",
    "end_time": "2024-12-05T16:20:00.000Z",
    "start_time_repeat": null,
    "end_time_repeat": null,
    "repeat_days": [
      "Mon",
      "Wed",
      "Fri"
    ]
  },
  "payment_methods": [
    "pay_id",
    "pay_to",
    "card"
  ],
  "status": "active",
  "tiers": [
    {
      "cashback_type": "percentage",
      "cashback_value": 10,
      "absolute_type": "min_order",
      "absolute_value": 100
    }
  ]
}

400

Bad Request

401

Unauthorized

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/cashbacks/configuration_campaign");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

page — query

per_page — query

status — query

ResponseClear

Click the Send API Request button above and see the response here!