Survey API

1 Get survey responses
- 1.1 GET /api/surveys/{all | survey_code}/responses V4

Get survey responses

`GET /api/surveys/{all | survey_code}/responses` V4

Retrieve survey responses.

use all if you are not sure which survey code to use
there are some predefined survey codes below

	Survey code	Description

	Survey code	Description
1	`all`	Return all surveys	Return all surveys
2	`cancel_intake_survey`	Cancel intake survey
3	`provider_visit_survey`	Post visit survey (provider side)
4	`cancel_call_survey`	Cancel call survey (patient side)
5	`post_visit_survey`

Parameters

Parameter	Type	Description

Parameter	Type	Description
`survey_code`	`String`	(required) survey code to be filtered with all - retrieve all surveys
`from_time` `to_time`	`Integer`	(optional) Start and end search period
`clinic_codes`	`String`	(optional) Comma separated value of clinic codes
`visit_ids`	`String`	(optional) Comma separated value of visit ids

Sample Request

curl --location 'https://api-ms.vsee.me/api/surveys/all/responses?clinic_codes=vclinic&limit=2' \
--header 'X-ApiToken: ***'

{
    "data": [
        {
            "id": "62685d75-b290-4e71-9bf6-33e464457b11",
            "survey_code": "cancel_call_survey",
            "clinic_code": "vclinic",
            "visit_id": "22183940",
            "intake_id": "",
            "room_code": "",
            "user_id": "16811538",
            "data": {
                "reason": "test_call",
                "member_id": "21728487",
                "provider_id": "0"
            },
            "created": 1651006837
        },
        …
    ],
    "total_count": 1131
}

Sample Request for cancel call survey only

curl --location 'https://api-ms.vsee.me/api/surveys/cancel_call_survey/responses?clinic_codes=vclinic&limit=2' \
--header 'X-ApiToken: ***'

Get survey responses

GET /api/surveys/{all | survey_code}/responses V4

`GET /api/surveys/{all | survey_code}/responses` V4