thymia Documentation

import requests
url = "https://api.example.com/v1/questionnaires/questionnaire_id"
payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "status": "RESULTS_AVAILABLE",
  "details": {
    "completedAt": "2024-05-10T09:45:00Z",
    "name": "General Anxiety Disorder Assessment",
    "questions": {
      "q1": "Over the last 2 weeks, how often have you been bothered by feeling nervous, anxious, or on edge?",
      "q2": "Over the last 2 weeks, how often have you been bothered by not being able to stop or control worrying?"
    },
    "answers": {
      "q1": "several_days",
      "q2": "more_than_half_the_days"
    },
    "scoreDetails": {
      "score": 7,
      "scoreMetadata": {
        "maxScore": 21,
        "interpretation": "Mild anxiety symptoms"
      }
    }
  }
}

Retrieves the status of an existing questionnaire, including results if they are available.

Authentication

x-api-keystring

Your API Activation Key

Path parameters

questionnaire_idstringRequiredformat: "uuid"

Response

Successful Response

statusenum

Current status of the questionnaire. Possible values:

RESULTS_NOT_AVAILABLE: Questionnaire has not been completed yet
RESULTS_AVAILABLE: Questionnaire has been completed and results are available

Allowed values:

detailsobject

Only populated if status is RESULTS_AVAILABLE

Errors

422

Unprocessable Entity Error