Get app settings v2

GET /v1/client/settings/v2

Get App Settings V2 returns the settings of the app.

Query parameters

  • color_scheme string

    optional parameter for setting color scheme of application (if appropriate visual object available)

    Values are LIGHT or DARK.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • currency object Required
        Hide currency attributes Show currency attributes object
        • floor_decimal boolean Required
        • factor string Required
        • symbol object Required
          Hide symbol attributes Show symbol attributes object
          • content string Required
          • is_image boolean Required
        • currency_promotion integer
        • bonus_percentage integer Required
        • name string Required
      • logic object Required
        Hide logic attributes Show logic attributes object
        • mode string Required

          Values are API, OFFERWALL, or ROUTER_LINK.

        • privacy_enabled boolean Required
        • skip_question_enabled boolean Required
        • header_navigation_visible boolean Required
        • watermark_visible boolean Required
        • survey_bonus_enabled boolean Required
        • demo_mode_enabled boolean Required
        • survey_opening_target string Required

          Values are OPENING_TARGET_NONE, OPENING_TARGET_NEW_TAB, OPENING_TARGET_SAME_TAB, OPENING_TARGET_PARENT, or OPENING_TARGET_AUTOMATIC.

        • survey_complete_target string Required

          Values are COMPLETE_TARGET_CLOSE_TAB, COMPLETE_TARGET_NEW_SURVEY, or COMPLETE_TARGET_URL.

        • first_qualification object Required
          Hide first_qualification attributes Show first_qualification attributes object
          • start_bonus string Required
          • show boolean Required
        • survey_complete_target_url string Required
        • survey_bonus_percentage integer Required
        • default_tab string Required

          Values are TAB_SURVEYS, TAB_OFFERS, TAB_GAMING, or TAB_MAGIC_RECEIPTS.

        • enabled_widgets array[string] Required

          Values are WIDGET_EARNINGS, WIDGET_LEADERBOARD, WIDGET_TRENDING_SURVEY, or WIDGET_QUALIFICATION_QUESTION.

      • visual object Required
        Hide visual attributes Show visual attributes object
        • element_border_radius string Required

          Values are BORDER_RADIUS_NONE, BORDER_RADIUS_SMALL, BORDER_RADIUS_MEDIUM, or BORDER_RADIUS_BIG.

        • custom_logo_url string Required
        • screenout_reward string Required
        • navigation_color string Required
        • background_color string Required
        • interaction_color string Required
        • survey_icon_color string Required
        • color_rating_threshold integer Required
        • offerwall_width string Required
        • hide_reward_value boolean Required
        • show_cross_tab_offers boolean Required
      • promotion object
        Hide promotion attributes Show promotion attributes object
        • start_date string(date-time) Required

          The start date of the promotion. Can be in the future to signal a scheduled promotion.

        • end_date string(date-time) Required

          The end date of the promotion. It is inclusive, meaning that the promotion is active for the full given day.

        • bonus_percentage integer Required
      • offers object Required
        Hide offers attributes Show offers attributes object
        • enabled boolean Required
        • offer_blacklist array[string] Required
      • publisher object Required
        Hide publisher attributes Show publisher attributes object
        • is_key_partner boolean Required
        • name string Required
      • chatbot_config object
        Hide chatbot_config attributes Show chatbot_config attributes object
        • id string Required
        • background string Required
        • ref integer Required
      • magic_receipts object Required
        Hide magic_receipts attributes Show magic_receipts attributes object
        • enabled boolean Required
        • test_mode boolean Required
        • enabled_countries array[string] Required
      • auths object Required
        Hide auths attributes Show auths attributes object
        • custom_fields array[object] Required
          Hide custom_fields attributes Show custom_fields attributes object
          • id string Required
          • data_type string Required

            Values are STRING, INTEGER, or DATE.

          • validation_exp string Required
          • title object Required
            Hide title attribute Show title attribute object
            • * string Additional properties
          • description object Required
            Hide description attribute Show description attribute object
            • * string Additional properties
          • placeholder object Required
            Hide placeholder attribute Show placeholder attribute object
            • * string Additional properties
          • format_example object Required
            Hide format_example attribute Show format_example attribute object
            • * string Additional properties
        • enabled boolean Required
      • gaming object Required
        Hide gaming attribute Show gaming attribute object
        • enabled boolean Required
      • user_balance object Required
        Hide user_balance attribute Show user_balance attribute object
        • enabled boolean Required
      • landing_page object Required
        Hide landing_page attributes Show landing_page attributes object
        • enabled boolean Required
        • hero_image_url string Required
        • explore_image_url string Required
      • loyalty object Required
        Hide loyalty attribute Show loyalty attribute object
        • program_name string Required
  • 406 application/json

    VPN detected

    Hide response attribute Show response attribute object
    • data object
GET /v1/client/settings/v2
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/settings/v2' \
 --header "X-Api-Token: $API_KEY"
Response examples (200)
{
  "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"
    }
  }
}
Response examples (406)
{
  "error": {
    "details": {
      "msg": "vpn detected",
      "http": "406 Not Acceptable"
    }
  }
}