v1

latestOpenAPI 3.0.02026-07-2663155142.2 KB

Surveys

Get click

Returns the next action to take for the given click. It returns the user's current progress and either a redirect target or a question to answer.

get/v2/client/clicks/{clickId}

Path parameters

clickIdstring required

click id

Response

Example response

{
  "data": {
    "answer_question": {
      "question": {
        "id": "e9bdff4e7d",
        "language": "en",
        "localized_text": "What is your favorite color?",
        "answers": [
          {
            "code": "1",
            "localized_text": "Red"
          }
        ],
        "can_skip": true,
        "validation_info": {
          "min": 1,
          "max": 1,
          "regex": "^.{1,30}$"
        }
      }
    },
    "redirect": {
      "url": "https://web.bitlabs.ai"
    },
    "survey_details": {
      "cpi": "1.2",
      "value": "120",
      "loi": 5.3,
      "country": "US",
      "language": "en",
      "rating": 4,
      "category": {
        "name": "Automotive",
        "name_internal": "automotive"
      }
    }
  }
}