BitLabs API

Leave survey Deprecated

POST /v1/client/networks/{networkId}/surveys/{surveyId}/leave

Header api token & Header user Query api token & Query user

Usually, we handle completes and screenouts of users. Nontheless, it may happen that a user wants to leave a
survey before it was terminated. In this case, you can report the leave using this endpoint with a reason given
by the user. This endpoint is optional but we use the feedback in real-time to filter out bad surveys to
improve the overall UX for all users.

Path parameters

networkId integer Required
surveyId integer(int64) Required

Body Required

reason string Required

Values are OTHER, TECHNICAL, SENSITIVE, TOO_LONG, or UNINTERESTING.

Responses

• 200 object

OK
- data object
- error object
  details object
  
  http string Required
  
  msg string Required
- status string Required
  
  Values are success or error.
- trace_id string Required
• 406 object

VPN detected
- data object
- error object
  details object
  
  http string Required
  
  msg string Required
- status string Required
  
  Values are success or error.
- trace_id string Required

POST /v1/client/networks/{networkId}/surveys/{surveyId}/leave

curl \
 -X POST https://api.bitlabs.ai/v1/client/networks/{networkId}/surveys/{surveyId}/leave \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"reason":"OTHER"}'

Request example

{
  "reason": "OTHER"
}

Response example (200)

{
  "data": {},
  "error": {
    "details": {
      "http": "string",
      "msg": "string"
    }
  },
  "status": "success",
  "trace_id": "1dc6786b10a62ec6"
}

Response example (406)

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