Documentation | Questions

API Reference

Questions

QuestionsResource

Methods

client.questions.create() ->

Question

post/v5/questions

Create Question

Parameters

configuration:

CategoricalQuestionRequestConfiguration

choices:

SequenceNotStr

[str]

Categorical answer choices (must contain at least one entry)

dropdown: Optional[

bool

]

Whether the question is displayed as a dropdown in the UI.

multi: Optional[

bool

]

Whether the question allows multiple answers.

name: str

prompt: str

user-facing question prompt

conditions: Optional[

Iterable

[Dict[str,

object

]]]

Conditions for the question to be shown

question_type: Optional[Literal["categorical"]]

(default: "categorical")

"categorical"

Returns

Question

class CategoricalQuestion: ...

class RatingQuestion: ...

class NumberQuestion: ...

class FreeTextQuestion: ...

class FormQuestion: ...

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
question = client.questions.create(
    configuration={
        "choices": ["string"]
    },
    name="name",
    prompt="prompt",
)
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",
  "conditions": [
    {
      "foo": "bar"
    }
  ],
  "object": "question",
  "question_type": "categorical"
}

client.questions.list() -> SyncCursorPage[

Question

]

get/v5/questions

List Questions

client.questions.retrieve() ->

Question

get/v5/questions/{question_id}

Get Question

Domain types

Question =

Question