Documentation | Questions

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
question = client.questions.update(
    question_id="question_id",
    name="x",
)
print(question)

200Example

{
  "id": "id",
  "configuration": {
    "choices": [
      "string"
    ],
    "dropdown": true,
    "multi": true
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "prompt": "prompt",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "conditions": [
    {
      "foo": "bar"
    }
  ],
  "object": "question",
  "question_type": "categorical"
}

client.questions.archive() ->

Question

delete/v5/questions/{question_id}

Archive a question by setting archived_at in the db

client.questions.restore() ->

Question

post/v5/questions/{question_id}/restore

Restore Archived Question

Domain types

class CategoricalQuestion: ...

class CategoricalQuestionConfiguration: ...

class FormQuestion: ...

class FormQuestionConfiguration: ...

class FreeTextQuestion: ...

class FreeTextQuestionConfiguration: ...

class NumberQuestion: ...

class NumberQuestionConfiguration: ...

Question

class RatingQuestion: ...

class RatingQuestionConfiguration: ...

class TimestampQuestion: ...

class TimestampQuestionConfiguration: ...