### GET Client Settings v2 API Response Example (200)

Source: https://docs.bitlabs.ai/operation/operation-getappsettingsv2

This is an example of a successful response (200 OK) when fetching client settings. It details the structure of the returned JSON object, which includes configurations for currency, logic, visual elements, promotions, and more.

```JSON
{
  "data": {
    "currency": {
      "floor_decimal": true,
      "factor": "string",
      "symbol": {
        "content": "string",
        "is_image": true
      },
      "currency_promotion": 40,
      "bonus_percentage": 20,
      "name": "Points"
    },
    "logic": {
      "mode": "API",
      "privacy_enabled": true,
      "skip_question_enabled": true,
      "header_navigation_visible": true,
      "watermark_visible": true,
      "survey_bonus_enabled": true,
      "demo_mode_enabled": true,
      "survey_opening_target": "OPENING_TARGET_NONE",
      "survey_complete_target": "COMPLETE_TARGET_CLOSE_TAB",
      "first_qualification": {
        "start_bonus": "string",
        "show": true
      },
      "survey_complete_target_url": "string",
      "survey_bonus_percentage": 50,
      "default_tab": "TAB_SURVEYS",
      "enabled_widgets": [
        "WIDGET_EARNINGS"
      ]
    },
    "visual": {
      "element_border_radius": "BORDER_RADIUS_NONE",
      "custom_logo_url": "string",
      "screenout_reward": "string",
      "navigation_color": "string",
      "background_color": "string",
      "interaction_color": "string",
      "survey_icon_color": "string",
      "color_rating_threshold": 42,
      "offerwall_width": "string",
      "hide_reward_value": true,
      "show_cross_tab_offers": true
    },
    "promotion": {
      "start_date": "2022-01-01T00:00:00Z",
      "end_date": "2022-01-15T00:00:00Z",
      "bonus_percentage": 20
    },
    "offers": {
      "enabled": true,
      "offer_blacklist": [
        "string"
      ]
    },
    "publisher": {
      "is_key_partner": true,
      "name": "string"
    },
    "chatbot_config": {
      "id": "string",
      "background": "string",
      "ref": 42
    },
    "magic_receipts": {
      "enabled": true,
      "test_mode": true,
      "enabled_countries": [
        "string"
      ]
    },
    "auths": {
      "custom_fields": [
        {
          "id": "string",
          "data_type": "STRING",
          "validation_exp": "string",
          "title": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "description": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "placeholder": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "format_example": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        }
      ],
      "enabled": true
    },
    "gaming": {
      "enabled": true
    },
    "user_balance": {
      "enabled": true
    },
    "landing_page": {
      "enabled": true,
      "hero_image_url": "string",
      "explore_image_url": "string"
    },
    "loyalty": {
      "program_name": "string"
    }
  }
}
```

--------------------------------

### Cashback Offers Response Example (200 OK)

Source: https://docs.bitlabs.ai/operation/operation-createandredirectclickv2

Example JSON response for the GET /v1/client/cashback/offers endpoint when successful (HTTP status code 200). It details the structure of the 'data' object containing an array of 'offers'.

```json
{
  "data": {
    "offers": [
      {
        "rank": 42,
        "terms": [
          {
            "term": "string",
            "payout": 42.0,
            "flat_payout": true
          }
        ],
        "primary_category": "string",
        "tier_mappings": [
          {
            "id": 42,
            "priority_order": 42,
            "tiers": [
              {
                "id": 42,
                "name": "string",
                "description": "string",
                "payout_type": "string",
                "user_value": "string"
              }
            ]
          }
        ],
        "currency": "string",
        "reward_delay_days": 42,
        "original_cashback": "string",
        "cashback": "string",
        "click_url": "string",
        "description": "string",
        "merchant_id": 42,
        "flat_payout": true,
        "up_to": true,
        "country_code": "string",
        "merchant_name": "string",
        "images": {
          "cardImage": "string",
          "backgroundImage": "string",
          "cardImageSmall": "string"
        }
      }
    ]
  }
}
```

--------------------------------

### Get App Settings (v1) - Response Examples

Source: https://docs.bitlabs.ai/operation/operation-getappsettings

Illustrates the JSON response structure for the deprecated 'Get App Settings' endpoint. Includes examples for a successful response (200 OK) with visual settings and an error response (406 Not Acceptable) indicating VPN detection.

```json
{
  "data": {
    "visual": {
      "color_dark": "string",
      "color_light": "string",
      "color_accent": "string"
    }
  }
}
```

```json
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}
```

--------------------------------

### GET /v1/client/promotions/welcome-bonus

Source: https://docs.bitlabs.ai/source

Get user's welcome bonus, if eligible.

```APIDOC
## GET /v1/client/promotions/welcome-bonus

### Description
Get user's welcome bonus, if eligible.

### Method
GET

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the welcome bonus details.

#### Response Example
```json
{
  "example": "{\"data\":{\"bonus_type\":\"FLAT_AMOUNT\",\"user_reward_currency\":0.43},\"status\":\"success\",\"trace_id\":\"2050914de1c94427\"}"
}
```
```

--------------------------------

### GET Cashback Offers API Endpoint

Source: https://docs.bitlabs.ai/operation/operation-getappsettingsv2

This describes the GET /v1/client/cashback/offers endpoint used to retrieve available cashback offers. It supports authentication via API token or bearer token and can accept user information through headers or query parameters.

```Markdown
## Get cashback offers 
GET  /v1/client/cashback/offers 
Header api token & Header user  Query api token & Query user  Header bearer token 
Get cashback offers.
```

--------------------------------

### Get User Balance JSON Response

Source: https://docs.bitlabs.ai/operation/operation-getgdprfilev2

Example JSON responses for the Get User Balance endpoint. The first example shows a successful response with the user's balance. The second example indicates a 'VPN detected' error.

```json
{
  "data": {
    "balance": "string"
  }
}
```

```json
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}
```

--------------------------------

### Get User Payout History - JSON Response Example

Source: https://docs.bitlabs.ai/operation/operation-getuserpayouthistory

This is an example JSON response for a successful request to get user payout history. It includes details of past payouts, such as ID, creation date, status, amount, and associated credentials.

```json
{
  "data": {
    "items": [
      {
        "payout_id": 123,
        "created_at": "2022-01-01T00:00:00Z",
        "status": "pending",
        "amount": "1.23",
        "category_id": "Amazon",
        "tier_id": "5",
        "status_updated_at": "2022-01-01T00:00:00Z",
        "estimated_delivery": 86400,
        "redemption_card_url": "https://www.amazon.com",
        "redemption_security_code": "1234567890",
        "credentials": [
          {
            "label": "Redemption Link",
            "value": "https://www.amazon.com",
            "type": "text",
            "credential_type": "redemptionUrl"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Example Response for Publisher Offers (JSON)

Source: https://docs.bitlabs.ai/operation/operation-accessuser

This is an example of a successful JSON response (200 OK) when retrieving publisher offers. It includes details about each offer, such as ID, name, country-specific statistics, description, requirements, and pending time.

```json
{
  "data": {
    "offers": [
      {
        "id": 42,
        "name": "Final Fantasy XV iPhone CPE (US) (Incentive)",
        "anchor": "Final Fantasy XV",
        "country_stats": [
          {
            "country_code": "US",
            "mobile_rank": 1,
            "desktop_rank": 422
          }
        ],
        "description": "Be the hero of your own Final Fantasy XV adventure in the brand new mobile strategy game Final Fantasy XV!",
        "requirements": "Install and Reach Citadel level 10.",
        "things_to_know": [
          "Must be a UK resident.",
          "Award will pend for 30 days."
        ],
        "disclaimer": "Must be a UK resident. ${currencyname} will appear as Pending for 30 days. This offer is presented to you by ${sitename} on behalf of a third party merchant. ${sitename} has not evaluated and does not endorse Merchant's views, policies, products or services.",
        "pending_time": 12
      }
    ]
  }
}
```

--------------------------------

### POST /v1/client/promotions/welcome-bonus

Source: https://docs.bitlabs.ai/changes_page=2

This is a newly added endpoint to claim a welcome bonus.

```APIDOC
## POST /v1/client/promotions/welcome-bonus

### Description
Claims the welcome bonus for the current user.

### Method
POST

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

#### Request Body
* None specified

### Request Example
```json
{
  "example": "No request body"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the bonus has been claimed.

#### Response Example
```json
{
  "message": "Welcome bonus claimed successfully."
}
```
```

--------------------------------

### GET /v1/client/networks/{networkId}/surveys/{surveyId}/open

Source: https://docs.bitlabs.ai/changes_page=8

Opens or starts a survey within a network.

```APIDOC
## GET /v1/client/networks/{networkId}/surveys/{surveyId}/open

### Description
Opens or starts a survey within a specific network. This endpoint was part of a breaking change update.

### Method
GET

### Endpoint
`/v1/client/networks/{networkId}/surveys/{surveyId}/open`

### Parameters
#### Path Parameters
- **networkId** (string) - Required - The identifier for the network.
- **surveyId** (string) - Required - The identifier for the survey.

### Request Example
(Example not provided in the input)

### Response
(Schema not provided in the input)
```

--------------------------------

### GET /v1/client/promotions/welcome-bonus (Added Endpoint)

Source: https://docs.bitlabs.ai/changes_page=2

This is a newly added endpoint to retrieve welcome bonus information.

```APIDOC
## GET /v1/client/promotions/welcome-bonus

### Description
Retrieves details of the welcome bonus promotion offered to new users.

### Method
GET

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

#### Query Parameters
* None specified

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains welcome bonus details.

#### Response Example
```json
{
  "data": {
    "bonus_id": "wb_abc",
    "value": 10,
    "currency": "USD"
  }
}
```
```

--------------------------------

### Get Survey Reconciliation Count Response (200)

Source: https://docs.bitlabs.ai/operation/operation-getsurveyreconciliationcount

Example of a successful response (HTTP 200) when getting the survey reconciliation count. It returns a JSON object containing the 'reconciliation_count'.

```json
{
  "data": {
    "reconciliation_count": 42
  }
}
```

--------------------------------

### GET /v1/client/cashback/offers

Source: https://docs.bitlabs.ai/operation/operation-getappsettingsv2

Retrieves a list of available cashback offers for the client. This endpoint returns detailed information about each offer, including merchant details, reward terms, and click URLs.

```APIDOC
## GET /v1/client/cashback/offers

### Description
Retrieves a list of available cashback offers for the client. This endpoint returns detailed information about each offer, including merchant details, reward terms, and click URLs.

### Method
GET

### Endpoint
/v1/client/cashback/offers

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/cashback/offers' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the list of offers.
  - **offers** (array[object]) - Required. A list of cashback offers.
    - **rank** (integer) - Required. The rank of the merchant.
    - **terms** (array[object]) - Required. Terms associated with the offer.
      - **term** (string) - The specific term condition.
      - **payout** (number) - The payout amount for the term.
      - **flat_payout** (boolean) - Indicates if the payout is a flat amount.
    - **primary_category** (string) - Required. The primary category of the offer.
    - **tier_mappings** (array[object]) - Required. Mappings for different tiers.
      - **id** (integer) - Required. The tier ID.
      - **priority_order** (integer) - Required. The order of priority for the tier.
      - **tiers** (array[object]) - Required. Details of the specific tiers.
        - **id** (integer) - Required. The tier ID.
        - **name** (string) - Required. The name of the tier.
        - **description** (string) - Required. A description of the tier.
        - **payout_type** (string) - Required. The type of payout for the tier.
        - **user_value** (string) - Required. The value associated with the user for this tier.
    - **currency** (string) - Required. The currency of the offer.
    - **reward_delay_days** (integer) - Required. The number of days to delay reward processing.
    - **original_cashback** (string) - Required. The original cashback amount.
    - **cashback** (string) - The current cashback amount.
    - **click_url** (string) - Required. The URL to click for the offer.
    - **description** (string) - Required. A description of the offer.
    - **merchant_id** (integer) - Required. The ID of the merchant.
    - **flat_payout** (boolean) - Required. Indicates if the offer has a flat payout.
    - **up_to** (boolean) - Required. Indicates if the offer is 'up to' a certain amount.
    - **country_code** (string) - Required. The country code for the offer.
    - **merchant_name** (string) - Required. The name of the merchant.
    - **images** (object) - Object containing image URLs.
      - **cardImage** (string) - Required. URL for the card image.
      - **backgroundImage** (string) - Required. URL for the background image.
      - **cardImageSmall** (string) - Required. URL for the small card image.

#### Response Example
```json
{
  "data": {
    "offers": [
      {
        "rank": 42,
        "terms": [
          {
            "term": "string",
            "payout": 42.0,
            "flat_payout": true
          }
        ],
        "primary_category": "string",
        "tier_mappings": [
          {
            "id": 42,
            "priority_order": 42,
            "tiers": [
              {
                "id": 42,
                "name": "string",
                "description": "string",
                "payout_type": "string",
                "user_value": "string"
              }
            ]
          }
        ],
        "currency": "string",
        "reward_delay_days": 42,
        "original_cashback": "string",
        "cashback": "string",
        "click_url": "string",
        "description": "string",
        "merchant_id": 42,
        "flat_payout": true,
        "up_to": true,
        "country_code": "string",
        "merchant_name": "string",
        "images": {
          "cardImage": "string",
          "backgroundImage": "string",
          "cardImageSmall": "string"
        }
      }
    ]
  }
}
```
```

--------------------------------

### POST /v1/client/promotions/welcome-bonus/spin

Source: https://docs.bitlabs.ai/source

Spin the user's wheel for a welcome bonus reward if available.

```APIDOC
## POST /v1/client/promotions/welcome-bonus/spin

### Description
Spin the user's wheel for a welcome bonus reward if available.

### Method
POST

### Endpoint
/v1/client/promotions/welcome-bonus/spin

### Parameters

### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the welcome bonus spin wheel response.

#### Response Example
```json
{
  "example": "{\"data\":{\"spin_wheel_welcome_bonus\":{\"reward_type\":\"COIN\",\"reward_value\":100}},\"status\":\"success\",\"trace_id\":\"some_trace_id\"}"
}
```
```

--------------------------------

### Get User History Cashback Details - VPN Detected Response (406)

Source: https://docs.bitlabs.ai/group/endpoint-cashback

This example shows the response when a VPN is detected (HTTP 406 Not Acceptable) while trying to retrieve user cashback details. The response body indicates the error with details and the corresponding HTTP status.

```json
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}
```

--------------------------------

### GET /v1/client/cashback/offers

Source: https://docs.bitlabs.ai/operation/operation-getappsettings

Retrieves a list of available cashback offers from Bitlabs AI.

```APIDOC
## GET /v1/client/cashback/offers

### Description
Retrieves a list of available cashback offers.

### Method
GET

### Endpoint
/v1/client/cashback/offers

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/cashback/offers' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the list of offers.
  - **offers** (array[object]) - Required. A list of cashback offers.
    - **rank** (integer) - Required. The rank of the merchant.
    - **terms** (array[object]) - Required.
      - **term** (string) - Required.
      - **payout** (number) - Optional.
      - **flat_payout** (boolean) - Optional.
    - **primary_category** (string) - Required.
    - **tier_mappings** (array[object]) - Required.
      - **id** (integer) - Required.
      - **priority_order** (integer) - Required.
      - **tiers** (array[object]) - Required.
        - **id** (integer) - Required.
        - **name** (string) - Required.
        - **description** (string) - Required.
        - **payout_type** (string) - Required.
        - **user_value** (string) - Required.
    - **currency** (string) - Required.
    - **reward_delay_days** (integer) - Required.
    - **original_cashback** (string) - Required.
    - **cashback** (string) - Required.
    - **click_url** (string) - Required.
    - **description** (string) - Required.
    - **merchant_id** (integer) - Required.
    - **flat_payout** (boolean) - Required.
    - **up_to** (boolean) - Required.
    - **country_code** (string) - Required.
    - **merchant_name** (string) - Required.
    - **images** (object) - Optional.
      - **cardImage** (string) - Required.
      - **backgroundImage** (string) - Required.
      - **cardImageSmall** (string) - Required.

#### Response Example
```json
{
  "data": {
    "offers": [
      {
        "rank": 42,
        "terms": [
          {
            "term": "string",
            "payout": 42.0,
            "flat_payout": true
          }
        ],
        "primary_category": "string",
        "tier_mappings": [
          {
            "id": 42,
            "priority_order": 42,
            "tiers": [
              {
                "id": 42,
                "name": "string",
                "description": "string",
                "payout_type": "string",
                "user_value": "string"
              }
            ]
          }
        ],
        "currency": "string",
        "reward_delay_days": 42,
        "original_cashback": "string",
        "cashback": "string",
        "click_url": "string",
        "description": "string",
        "merchant_id": 42,
        "flat_payout": true,
        "up_to": true,
        "country_code": "string",
        "merchant_name": "string",
        "images": {
          "cardImage": "string",
          "backgroundImage": "string",
          "cardImageSmall": "string"
        }
      }
    ]
  }
}
```
```

--------------------------------

### GET /v1/client/promotions/welcome-bonus

Source: https://docs.bitlabs.ai/changes_page=2

Retrieves information about the welcome bonus promotion. A 'claimed_at' property has been added to the 'data' object in the response.

```APIDOC
## GET /v1/client/promotions/welcome-bonus

### Description
Retrieves details of the welcome bonus promotion offered to new users.

### Method
GET

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

#### Query Parameters
* None specified

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains welcome bonus details.
  - **claimed_at** (string) - Timestamp when the welcome bonus was claimed (ISO 8601 format).

#### Response Example
```json
{
  "data": {
    "bonus_id": "wb_abc",
    "value": 10,
    "currency": "USD",
    "claimed_at": "2025-07-07T12:00:00Z"
  }
}
```
```

--------------------------------

### Get User History Cashback Details - Success Response (200)

Source: https://docs.bitlabs.ai/group/endpoint-cashback

This is an example of a successful response (HTTP 200 OK) when retrieving user cashback details. It returns a JSON object containing comprehensive information about the cashback offer, including its ID, merchant details, status, creation date, amount, and reward delay.

```json
{
  "data": {
    "id": 42,
    "merchant_ref": "string",
    "merchant_name": "string",
    "status_reason": "string",
    "order_id": "string",
    "event_name": "string",
    "status": "completed",
    "created_at": "2022-01-01T00:00:00Z",
    "amount": "1.23",
    "reward_delay_days": 47
  }
}
```

--------------------------------

### GET /v1/client/promotions/referral-info

Source: https://docs.bitlabs.ai/source

Get user's referral info.

```APIDOC
## GET /v1/client/promotions/referral-info

### Description
Allow a user to view information regarding their role as a referrer.

### Method
GET

### Endpoint
/v1/client/promotions/referral-info

### Parameters

### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains referral information.

#### Response Example
```json
{
  "example": "{\"data\":{\"code\":\"GH89pT\",\"total_amount_earned_as_referrer\":80.44,\"total_amount_earned_as_referred\":230.44,\"total_referrals\":50},\"status\":\"success\",\"trace_id\":\"2050914de1c94427\"}"
}
```
```

--------------------------------

### GET /v1/client/promotions/welcome-bonus

Source: https://docs.bitlabs.ai/changes_page=1

This endpoint was modified in version 2.0.115. The response structure for the welcome bonus has been updated with a new 'spin_details' property.

```APIDOC
## GET /v1/client/promotions/welcome-bonus

### Description
Retrieves information about the welcome bonus for the client.

### Method
GET

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Contains details about the welcome bonus.
  - **spin_details** (object) - Details related to a spin, added in v2.0.115.

#### Response Example
```json
{
  "data": {
    "spin_details": {}
  }
}
```
```

--------------------------------

### GET /v1/client/promotions/referral-bonus

Source: https://docs.bitlabs.ai/source

Get user's referral bonus info.

```APIDOC
## GET /v1/client/promotions/referral-bonus

### Description
Allow a user to view information regarding their referral from another user.

### Method
GET

### Endpoint
/v1/client/promotions/referral-bonus

### Parameters

### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains referral bonus information.

#### Response Example
```json
{
  "example": "{\"data\":{\"active\":true,\"valid_until\":\"2020-05-04T17:01:30Z\",\"commission_percentage\":12.5},\"status\":\"success\",\"trace_id\":\"2050914de1c94427\"}"
}
```
```

--------------------------------

### POST /v1/client/promotions/welcome-bonus/wheel-spin

Source: https://docs.bitlabs.ai/changes_page=1

This endpoint was added in version 2.0.115 and is used to perform a wheel spin action related to the welcome bonus.

```APIDOC
## POST /v1/client/promotions/welcome-bonus/wheel-spin

### Description
Initiates a wheel spin action for the welcome bonus.

### Method
POST

### Endpoint
/v1/client/promotions/welcome-bonus/wheel-spin

### Parameters

### Request Body

### Request Example
None provided.

### Response
#### Success Response (200)
Details of the response are not specified in the changelog.

#### Response Example
None provided.
```

--------------------------------

### GET /v1/client/cashback/offers

Source: https://docs.bitlabs.ai/operation/operation-testcallbackurl

Get cashback offers.

```APIDOC
## GET /v1/client/cashback/offers

### Description
Get cashback offers.

### Method
GET

### Endpoint
/v1/client/cashback/offers

### Query Parameters
- **api_token** (string) - Required - API token for authentication.
- **user** (string) - Required - User identifier.

### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Responses
(No specific success or error response details provided in the input text.)

### Request Example
(No request example provided in the input text.)

### Response Example
(No response example provided in the input text.)
```

--------------------------------

### GET /v1/client/cashback/offers

Source: https://docs.bitlabs.ai/operation/operation-performtestcallback

Get cashback offers.

```APIDOC
## GET /v1/client/cashback/offers

### Description
Get cashback offers.

### Method
GET

### Endpoint
/v1/client/cashback/offers

### Parameters
#### Query Parameters
- **api_token** (string) - Required
- **user** (string) - Required

### Headers
- `api_token` (string) - Required
- `user` (string) - Required
- `Authorization: Bearer <BEARER_TOKEN>` (string) - Required
```

--------------------------------

### POST /v1/client/promotions/welcome-bonus/wheel-spin

Source: https://docs.bitlabs.ai/changes/aacfc5a6

Initiates a wheel spin for the welcome bonus promotion. This endpoint was added in the latest update.

```APIDOC
## POST /v1/client/promotions/welcome-bonus/wheel-spin

### Description
Initiates a wheel spin for the welcome bonus promotion. This endpoint was added in the latest update.

### Method
POST

### Endpoint
/v1/client/promotions/welcome-bonus/wheel-spin

### Request Body
*Note: No specific request body details were provided in the changelog.*

### Response
#### Success Response (200)
*Note: Specific success response details were not provided in the changelog.*

#### Response Example
*Note: A response example was not provided in the changelog.*
```

--------------------------------

### GET /client/surveys Addition (v1.0.57)

Source: https://docs.bitlabs.ai/changes_page=9

This section details the addition of the GET /client/surveys endpoint.

```APIDOC
## GET /client/surveys (v1.0.57)

### Description
Retrieves client surveys.

### Method
GET

### Endpoint
/client/surveys

### Request Example
```json
{
  "example": "GET /client/surveys"
}
```

### Response
#### Success Response (200)
- **data** (object) - Information about client surveys.

#### Response Example
```json
{
  "example": "{\"data\": {}}"
}
```
```

--------------------------------

### GET /client/offers

Source: https://docs.bitlabs.ai/changes_page=10

Retrieves a list of available offers.

```APIDOC
## GET /client/offers

### Description
Retrieves a list of available offers.

### Method
GET

### Endpoint
/client/offers

### Parameters

#### Query Parameters

#### Request Body

### Request Example

### Response
#### Success Response (200)

#### Response Example

```

--------------------------------

### GET /client/user/data/web Removals (Breaking Change)

Source: https://docs.bitlabs.ai/changes_page=9

This section details the removal of the GET /client/user/data/web endpoint. This is a breaking change.

```APIDOC
## GET /client/user/data/web (Breaking Change)

### Description
This endpoint has been removed. Please use alternative methods if available. This is a breaking change.

### Method
GET

### Endpoint
/client/user/data/web

### Request Example
```json
{
  "example": "GET /client/user/data/web"
}
```

### Response
This endpoint is no longer available.
```

--------------------------------

### Application Settings Schemas

Source: https://docs.bitlabs.ai/source

Provides definitions for various application settings, including promotion, offers, publisher, and more.

```APIDOC
## Schemas

### AppSettingsV2Promotion
Settings for promotions.
- **start_date** (string) - Required - The start date of the promotion.
- **end_date** (string) - Required - The end date of the promotion.
- **bonus_percentage** (integer) - Required - The bonus percentage for the promotion.

### AppSettingsV2Offers
Settings for offers.
- **enabled** (boolean) - Required - Whether offers are enabled.
- **offer_blacklist** (array[string]) - Required - A list of blacklisted offer IDs.

### AppSettingsV2Publisher
Settings for publishers.
- **is_key_partner** (boolean) - Required - Whether the publisher is a key partner.
- **name** (string) - Required - The name of the publisher.

### AppSettingsV2MagicReceipts
Settings for Magic Receipts feature.
- **enabled** (boolean) - Required - Whether Magic Receipts is enabled.
- **test_mode** (boolean) - Required - Whether test mode is enabled.
- **enabled_countries** (array[string]) - Required - List of countries where Magic Receipts is enabled.

### AppSettingsV2Gaming
Settings for the gaming feature.
- **enabled** (boolean) - Required - Whether gaming is enabled.

### AppSettingsV2Auths
Settings for authentication.
- **custom_fields** (array[AppSettingsV2CustomField]) - Required - List of custom authentication fields.
- **enabled** (boolean) - Required - Whether authentication is enabled.

### AppSettingsV2UserBalance
Settings for user balance.
- **enabled** (boolean) - Required - Whether user balance is enabled.

### AppSettingsV2LandingPage
Settings for the landing page.
- **enabled** (boolean) - Required - Whether the landing page is enabled.
- **hero_image_url** (string) - Required - URL for the hero image.
- **explore_image_url** (string) - Required - URL for the explore image.

### AppSettingsV2Loyalty
Settings for the loyalty program.
- **program_name** (string) - Required - The name of the loyalty program.

### AppSettingsV2CustomField
Defines a custom field for authentication.
- **id** (string) - Required - The ID of the custom field.
- **data_type** (string) - Required - The data type (STRING, INTEGER, DATE).
- **validation_exp** (string) - Required - Regular expression for validation.
- **title** (object) - Required - Localized titles for the field.
- **description** (object) - Required - Localized descriptions for the field.
- **placeholder** (object) - Required - Localized placeholder texts.
- **format_example** (object) - Required - Localized format examples.
```

--------------------------------

### POST /v1/client/promotions/welcome-bonus

Source: https://docs.bitlabs.ai/source

Claim user's welcome bonus, if eligible.

```APIDOC
## POST /v1/client/promotions/welcome-bonus

### Description
Claim user's welcome bonus, if eligible.

### Method
POST

### Endpoint
/v1/client/promotions/welcome-bonus

### Parameters

### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Empty object indicating successful claim.

#### Response Example
```json
{
  "example": "{\"status\":\"success\",\"trace_id\":\"2050914de1c94427\"}"
}
```
```

--------------------------------

### GET /client/user/data Removals (Breaking Change)

Source: https://docs.bitlabs.ai/changes_page=9

This section details the removal of the GET /client/user/data endpoint. This is a breaking change.

```APIDOC
## GET /client/user/data (Breaking Change)

### Description
This endpoint has been removed. Please use alternative methods if available. This is a breaking change.

### Method
GET

### Endpoint
/client/user/data

### Request Example
```json
{
  "example": "GET /client/user/data"
}
```

### Response
This endpoint is no longer available.
```

--------------------------------

### GET /v1/client/offers/{offerId}/open

Source: https://docs.bitlabs.ai/changes_page=8

Opens a specific offer for the client.

```APIDOC
## GET /v1/client/offers/{offerId}/open

### Description
Opens a specific offer for the client, identified by its ID. This endpoint was part of a breaking change update.

### Method
GET

### Endpoint
`/v1/client/offers/{offerId}/open`

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The unique identifier for the offer.

### Request Example
(Example not provided in the input)

### Response
(Schema not provided in the input)
```

--------------------------------

### GET /client/gdpr/files/{filename}/{hash} Addition

Source: https://docs.bitlabs.ai/changes_page=9

This section details the addition of the GET /client/gdpr/files/{filename}/{hash} endpoint.

```APIDOC
## GET /client/gdpr/files/{filename}/{hash}

### Description
Retrieves GDPR files.

### Method
GET

### Endpoint
/client/gdpr/files/{filename}/{hash}

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the GDPR file.
- **hash** (string) - Required - The hash of the GDPR file.

### Request Example
```json
{
  "example": "GET /client/gdpr/files/report.pdf/abcdef123456"
}
```

### Response
#### Success Response (200)
- **data** (string) - Content of the GDPR file.

#### Response Example
```json
{
  "example": "{\"data\": \"file content\"}"
}
```
```

--------------------------------

### GET /publishers/users/{userId}/profile Addition

Source: https://docs.bitlabs.ai/changes_page=9

This section details the addition of the GET /publishers/users/{userId}/profile endpoint.

```APIDOC
## GET /publishers/users/{userId}/profile

### Description
Retrieves the profile information for a specific publisher user.

### Method
GET

### Endpoint
/publishers/users/{userId}/profile

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the publisher user.

### Request Example
```json
{
  "example": "GET /publishers/users/12345/profile"
}
```

### Response
#### Success Response (200)
- **data** (object) - Publisher user profile information.

#### Response Example
```json
{
  "example": "{\"data\": {}}"
}
```
```