특정 설문(form_id)에 제출된 답변 데이터를 가져옵니다.
[GET] https://api.moaform.com/v1/forms/{form_id}/responses
요청
Path Parameters
| Key | Description |
|---|---|
| form_id | 필수. 설문의 고유 ID |
Query Parameters
| Key | Type | Description |
|---|---|---|
| page | integer | 가져올 목록의 페이지. 기본값 1 |
| page_size | integer | 페이지당 가져올 목록의 개수. 기본값 25, 최대값 1000 |
| since | string | 지정된 날짜와 시간 이후로 제출된 답변으로 요청을 제한 (예: 2020-03-20T14:00:59Z) |
| until | string | 지정된 날짜와 시간 이전으로 제출된 답변으로 요청을 제한 (예: 2020-03-20T14:00:59Z) |
| after | string | 지정된 response_id 후에 제출된 답변으로 제한. 해당 response_id 미포함 |
| before | string | 지정된 response_id 전에 제출된 답변으로 제한. 해당 response_id 미포함 |
| included_response_ids | string | 지정된 response_id를 포함하는 답변으로 제한. 여러개를 지정하려면 쉼표로 구분하여 요청 |
| excluded_response_ids | string | 지정된 response_id를 제외한 답변으로 제한. 여러개를 지정하려면 쉼표로 구분하여 요청 |
| sort_by | string | 목록 정렬 필드. 기본값은 `submitted_at`(현재 `submitted_at` 만 허용) |
| order_by | string | 정렬 순서. 기본값 `asc`(오름차순 정렬 `asc`, 내림차순 정렬 `desc`중 하나) |
응답
| Key | Type | Description |
|---|---|---|
| total_items | integer | 결과 목록의 전체 개수 |
| page_count | integer | 페이지 개수 |
| items | [object] | |
| ↳ hidden | object | |
| ↳ d[n] | string | 히든필드가 있을 경우에만 모든 히든 필드들을 같은 위계로 표시. n=1~100 |
| ↳ response_id | string | 답변의 고유 ID |
| ↳ submitted_at | string | 답변 제출 일시 |
| ↳ metadata | object | |
| ↳ browser | string | 답변자 브라우저 정보 |
| ↳ operating_system | string | 답변자 운영체제 정보 |
| ↳ device | string | 답변자 장치 정보 |
| ↳ user_agent | string | 답변자의 User Agent |
| ↳ answers | [object] | |
| ↳ block | object | |
| ↳ id | string | 항목의 고유 ID |
| ↳ type | string | 항목의 타입 |
| ↳ type | string | 답변의 타입 (아래 별도 table 에서 타입별로 계속 설명. 각 타입별로 이 KEY를 포함하여 아래 ... 위치를 대체) |
| ... | ... | ... |
| ↳ thankyou | object | |
| ↳ id | string | 맺음말의 고유 ID |
| ↳ url | string | 맺음말의 URL |
답변의 type 상세
choice (여러 보기들 중 하나만 선택)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | choice |
| ↳ choice | object | |
| ↳ id | string | 보기의 고유 ID |
| ↳ label | string | 보기의 내용 |
| ↳ score | integer | 보기에 할당된 점수 (점수가 할당되어야만 나옴) |
| ↳ other | string | 기타 보기에 입력한 답변 (기타 답변일 경우에만 나타남) |
choices (여러 보기들 중 여러개 선택)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | choices |
| ↳ choices | [object] | |
| ↳ id | string | 보기의 고유 ID |
| ↳ label | string | 보기의 내용 |
| ↳ score | integer | 보기에 할당된 점수 (점수가 할당되어야만 나옴) |
| ↳ other | string | 기타 보기에 입력한 답변 (기타 답변일 경우에만 나타남) |
순위형 질문의 경우 나열되는 답변의 순서가 곧 순위입니다.
media_choice (여러 미디어 보기들 중 하나만 선택)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | media_choice |
| ↳ media_choice | object | |
| ↳ id | string | 보기의 고유 ID |
| ↳ label | string | 보기의 내용 |
| ↳ score | integer | 보기에 할당된 점수 (점수가 할당되어야만 나옴) |
| ↳ other | string | 기타 보기에 입력한 답변 (기타 답변일 경우에만 나타남) |
| ↳ media | object | |
| ↳ type | string | 미디어 형태 (현재는 image only) |
| ↳ url | string | 이미지 URL |
media_choices (여러 미디어 보기들 중 여러개 선택)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | media_choices |
| ↳ media_choices | [object] | |
| ↳ id | string | 보기의 고유 ID |
| ↳ label | string | 보기의 내용 |
| ↳ score | integer | 보기에 할당된 점수 (점수가 할당되어야만 나옴) |
| ↳ other | string | 기타 보기에 입력한 답변 (기타 답변일 경우에만 나타남) |
| ↳ media | object | |
| ↳ type | string | 미디어 형태 (현재는 image only) |
| ↳ url | string | 이미지 URL |
순위형 질문의 경우 나열되는 답변의 순서가 곧 순위입니다.
text (주관식)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | text |
| ↳ text | string | 텍스트 입력값 |
| ↳ encrypted | boolean | 답변 암호화 저장 여부 ("true" 일때만 나옴) |
email (이메일)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | |
| string | 이메일 주소 | |
| ↳ encrypted | boolean | 답변 암호화 저장 여부 ("true" 일때만 나옴) |
url (url)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | url |
| ↳ url | string | 웹사이트 URL |
| ↳ encrypted | boolean | 답변 암호화 저장 여부 ("true" 일때만 나옴) |
number (답변이 숫자인 경우, 척도형, 별점형, 수치입력형 등)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | number |
| ↳ number | number | 답변 숫자값 |
| ↳ encrypted | boolean | 답변 암호화 저장 여부 (수치입력형만, "true" 일때만 나옴) |
address (주소)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | address |
| ↳ address | [object] | |
| ↳ street | string | street 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ detail | string | detail 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ city | string | city 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ region | string | region 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ postal_code | string | postal_code 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ country | string | country 입력값 (visibile_fields로 정의되어야만 나옴) |
| ↳ encrypted | boolean | 답변 암호화 저장 여부 ("true" 일때만 나옴) |
files (첨부파일)
| Key | Type | Description |
|---|---|---|
| ↳ type | string | files |
| ↳ files | [object] | |
| ↳ name | string | 파일명 |
| ↳ size | integer | 파일 사이즈 |
| ↳ url | [object] | |
| ↳ api | string | 파일 다운로드 API URL |
| ↳ report | string | 파일 다운로드 웹사이트 URL |