Documentation | Questions › list

Questions

QuestionsResource

Methods

client.questions.create() ->

post/v5/questions

Create Question

client.questions.list() -> SyncCursorPage[

]

get/v5/questions

List Questions

Parameters

ending_before: Optional[str]

ids: Optional[Sequence[str]]

include_archived: Optional[

]

limit: Optional[int]

(maximum: 10000, minimum: 1, default: 100)

sort_by: Optional[str]

sort_order: Optional[

]

starting_after: Optional[str]

Returns

CategoricalQuestion

FreeTextQuestion

TimestampQuestion

Request example

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
)
page = client.questions.list()
page = page.items[0]
print(page)

200Example

{
  "has_more": true,
  "items": [
    {
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.questions.retrieve() ->

get/v5/questions/{question_id}

Get Question

client.questions.update(, ) ->

patch/v5/questions/{question_id}

Update Question

client.questions.archive() ->

delete/v5/questions/{question_id}

Archive a question by setting archived_at in the db

client.questions.restore() ->

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: ...

class RatingQuestion: ...

class RatingQuestionConfiguration: ...

class TimestampQuestion: ...

class TimestampQuestionConfiguration: ...