Sign in

v1

latestOpenAPI 3.0.02026-07-2663155142.2 KB
Surveys

Update click

Updates the click with the action and returns the changed state of the click, hence the GET click endpoint does not have to be called after calling this endpoint.

The action can be one of the following:

  • answer - answers a question
  • skip - skip a question, if skipping is allowed
  • leave - either leaves the survey or the click flow with a supplied reason
  • rate - when a survey is completed, this action can be used to rate the survey
post/v2/client/clicks/{clickId}

Path parameters

clickIdstring required

click id

Request body

skip_questionboolean

Example request

{
  "answer_question": {
    "answers": [
      "1",
      "2"
    ]
  }
}

Response

OK

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"
      }
    }
  }
}