{
  "openapi": "3.0.3",
  "info": {
    "title": "Survey API",
    "version": "3.0",
    "contact": {
      "email": "admin@vsee.com"
    }
  },
  "servers": [
    {
      "url": "https://api-ms.vsee.me/api",
      "description": "Production V4"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "javascript",
      "java"
    ]
  },
  "tags": [
    {
      "name": "Surveys",
      "description": "Survey response management"
    }
  ],
  "paths": {
    "/surveys/{survey_code}/responses": {
      "get": {
        "tags": [
          "Surveys"
        ],
        "summary": "Get survey responses",
        "description": "Retrieve survey responses based on survey code and optional filters",
        "operationId": "getSurveyResponses",
        "parameters": [
          {
            "name": "X-ApiToken",
            "in": "header",
            "description": "API token",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "your_api_token"
          },
          {
            "name": "survey_code",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "cancel_intake_survey",
                "provider_visit_survey",
                "cancel_call_survey",
                "post_visit_survey"
              ]
            },
            "description": "Survey code to filter responses. Use 'all' to retrieve all surveys"
          },
          {
            "name": "from_time",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "description": "UNIX timestamp for start of search period"
          },
          {
            "name": "to_time",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "description": "UNIX timestamp for end of search period"
          },
          {
            "name": "clinic_codes",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated list of clinic codes to filter"
          },
          {
            "name": "visit_ids",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated list of visit IDs to filter"
          }
        ],
        "responses": {
          "200": {
            "description": "Survey responses retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/SurveyResponse"
                      }
                    },
                    "total_count": {
                      "type": "integer"
                    }
                  }
                },
                "examples": {
                  "cancelCallSurvey": {
                    "value": {
                      "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
                    }
                  }
                }
              }
            }
          }
        },
        "x-auth-type": "user-token"
      }
    }
  },
  "components": {
    "schemas": {
      "SurveyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "survey_code": {
            "type": "string",
            "enum": [
              "all",
              "cancel_intake_survey",
              "provider_visit_survey",
              "cancel_call_survey",
              "post_visit_survey"
            ]
          },
          "clinic_code": {
            "type": "string"
          },
          "visit_id": {
            "type": "string"
          },
          "intake_id": {
            "type": "string"
          },
          "room_code": {
            "type": "string"
          },
          "user_id": {
            "type": "string"
          },
          "data": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "created": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}