> ## Documentation Index > Fetch the complete documentation index at: https://docurise.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # 폼 퍼널 조회 > 내 폼 하나의 방문, 제출 버튼 클릭, 제출 수와 단계별 전환율을 UTC 기간으로 조회합니다 ## OpenAPI ````yaml api-reference/openapi.ko.yaml GET /api/preview/documents/{id}/analytics/funnel openapi: 3.1.0 info: title: DocuRise 퍼블릭 API version: preview description: > DocuRise 프로그래매틱 접근입니다. **이 API는 프리뷰 단계입니다.** 모든 경로는 `/api/preview/` 하위에 버전이 지정되어 있으며, 프리뷰 단계에서는 호환성을 보장하지 않습니다 — 필드, 값, 에러 코드가 추가, 변경 또는 제거될 수 있습니다. 계약이 안정화되면 `/api/v1/`로 승격됩니다. 변경 사항은 [변경 이력](/ko/changelog)에서 확인하세요. ### 접근 조건 모든 라우트는 다음을 요구합니다: 1. 유효한 API 키 (아래 인증 참고). 2. 호출하는 계정의 요금제가 **Iconic 이상**이어야 합니다. 3. 프리뷰 기간 동안 API는 일부 계정에서만 사용이 가능하며, 요금제와는 별개입니다. 사용할 수 없는 계정은 아래 모든 라우트에서 `404`를 받습니다. 사용할 수 있어야 하는 계정이라면 DocuRise 담당자에게 문의하세요. 키 발급 및 관리는 대시보드의 **Settings → Developers**에서 할 수 있습니다. ### 멱등성(Idempotency) 리소스를 생성하는 `POST` 엔드포인트는 `Idempotency-Key` 헤더가 필요합니다. 같은 키와 같은 요청 본문으로 재요청하면 두 번째 리소스를 만드는 대신 원래 응답(동일한 상태 코드, 동일한 본문)을 그대로 반환합니다 — 타임아웃이나 연결 끊김 시 안전하게 재시도할 수 있습니다. 키는 7일 동안 기억되며, 그 이후에 같은 키로 요청하면 새 요청으로 처리됩니다. 같은 키를 **다른** 본문으로 재사용하면 `IDEMPOTENCY_KEY_CONFLICT`로 거부됩니다. 매 논리적 작업마다 새로운 키(UUID나 ULID면 충분)를 생성하세요 — HTTP 시도마다 새로 생성하지 마세요. 예외: `POST /api/preview/tags`는 `Idempotency-Key`를 받지 않습니다. 같은 이름의 태그를 두 번 만들어도 아무것도 바뀌지 않으므로(두 번째 호출은 기존 태그를 `created: false`로 반환), 재시도는 항상 안전합니다. 또 다른 예외: `POST /api/preview/segments/preview`는 `Idempotency-Key`를 받지 않습니다. 아무것도 저장하지 않으므로 반복 호출해도 항상 안전합니다. ### 응답 호환성 응답은 시간이 지나면서 필드가 추가될 수 있고, `type`/`code` 형태의 열거값(예를 들어 향후 추가될 `LeadFormQuestion.type` 값이나 새로운 에러 `code`)도 새 값이 늘어날 수 있습니다. 알지 못하는 필드나 열거값은 항상 무시하고 에러로 취급하지 마세요 — 이것이 `preview` 기간 동안의 모든 추가적 변경을 하위 호환되게 만드는 원칙입니다. 응답에서 필드가 아예 없는 것과 값이 `null`로 존재하는 것은 항상 같은 의미가 아닙니다. 타입에 `null`이 전혀 포함되지 않는 필드는 해당하지 않을 때 아예 생략됩니다 — `null`로 전송되는 일은 없습니다(예를 들어 `retryAfterSeconds`는 백오프 힌트가 없을 때 완전히 생략되며, `null`로 설정되지 않습니다). 타입에 `null`을 명시적으로 허용하는 필드는 "값이 없음"과는 구분되는 실제 의미로 `null`을 사용합니다(예를 들어 문서의 `expiresAt: null`은 "알 수 없음"이나 "해당 없음"이 아니라, 고정 만료일이 없다는 뜻입니다). 모든 필드명은 `notionUrl`, `leadFormQuestions`, `collectName` 등과 같이 모든 요청/응답 본문에서 일관되게 `camelCase`를 사용합니다. ### 식별자 `id` 값은 불투명한(opaque) 문자열입니다. 구조화되지 않은 토큰으로 저장하고 비교하세요 — 파싱하거나 형식을 검증하거나 길이·문자 구성에 대해 어떤 가정도 하지 마세요. ### 에러 모든 에러 응답은 동일한 형식을 갖습니다: ```json { "error": { "code": "STRING", "message": "human-readable", "retryable": false } } ``` `message`가 아니라 `code`를 기준으로 분기하세요 — `message`는 로그/디버깅용 자유 텍스트이며 예고 없이 문구가 바뀔 수 있습니다. `code`가 안정적인 계약입니다. `retryable`은 동일한 요청을 그대로 재시도해도 되는지를 나타내며, 존재할 경우 `retryAfterSeconds`가 구체적인 백오프 힌트를 제공합니다. 요청 본문에 NUL 문자(`\u0000`)가 문자열 값이나 속성 이름에 들어 있으면 아무것도 저장하기 전에 `400 VALIDATION_ERROR`로 거부됩니다. ### 속도 제한 계정이 보유한 키 개수와 무관하게, 모든 `/api/preview/*` 라우트에 대해 계정당 분당 60회 요청으로 제한됩니다. 초과 시 `Retry-After` 헤더와 함께 `429`가 반환됩니다. 이와 별도로, 계정이 보유한 키 개수와 무관하게 이 라우트들에서 한 계정이 동시에 실행 중인 요청은 최대 10개입니다. 11번째가 될 요청은 `code: TOO_MANY_CONCURRENT_REQUESTS`와 `Retry-After: 1`이 담긴 `429`를 반환합니다. 실행 중인 요청 하나가 끝날 때까지 기다린 뒤 재시도하세요. 이 제한은 아직 끝나지 않은 요청을 세므로, 분당 60회 이내여도 적용될 수 있습니다. contact: name: DocuRise url: https://docurise.io servers: - url: https://docurise.io description: 프로덕션 security: - apiKey: [] tags: - name: Documents description: >- 문서(노션 페이지, 포스트, 리드 수집 폼)를 생성하고, 내가 소유한 문서를 목록 조회하거나 읽고, 초안을 게시하며, 상태, 만료일, 이메일 보호 설정을 변경합니다. - name: Analytics description: >- 내 문서 하나의 조회, 방문자, 리드, 전환 집계 수치를 조회하고, 유입 채널별 분포, 이전 기간과의 비교, 폼 퍼널로도 확인하며, 내 모든 문서를 조회, 방문자, 리드 기준으로 순위를 매겨 조회합니다. - name: Folders description: 폴더와 강의를 항목 수와 함께 조회합니다. - name: Products description: 상품 카탈로그를 조회합니다(읽기 전용). - name: Audiences description: >- 태그와 그룹을 연락처 수와 함께 조회하고, 규칙으로 그룹을 만들고, 규칙에 맞는 연락처 수를 미리 세고, 그룹 하나를 규칙과 함께 조회합니다. 수치만 제공하며 연락처 정보는 절대 반환하지 않습니다. - name: Contacts description: 내 연락처 하나에 태그를 추가하거나 제거합니다. 연락처 정보는 반환하지 않습니다. - name: Email description: 이메일 1회성 발송, 1회성 발송별 집계 수치, 자동화를 조회합니다. 이메일만 해당하며 카카오는 포함되지 않습니다. - name: Instagram description: Instagram 댓글-DM 자동화 규칙을 생성, 조회, 수정, 일시정지, 재개합니다. - name: Account description: 호출에 사용 중인 API 키를 확인합니다. paths: /api/preview/documents/{id}/analytics/funnel: parameters: - name: id in: path required: true description: 폼 문서의 id. schema: type: string format: uuid get: tags: - Analytics summary: 폼 퍼널 조회 description: | 내 **폼** 문서 하나의 기간 동안의 전환 퍼널을 반환합니다. 방문한 사람 수, 제출 또는 결제 버튼을 누른 사람 수, 제출한 수와 단계 사이의 전환율입니다. `analytics:read` 범위가 필요합니다. 존재하지 않거나 내 것이 아닌 문서는 `403`이 아니라 `404 DOCUMENT_NOT_FOUND`입니다. 내 문서이지만 폼이 아닌 문서 (Notion 페이지, PDF, 업로드, 포스트)는 `422 NOT_A_FORM_DOCUMENT`이며, 그런 문서에는 `GET /documents/{id}/analytics`를 사용하세요. **기간.** `GET /documents/{id}/analytics`와 같습니다. `from`과 `to`는 필수이며 `Z` 또는 숫자 오프셋이 붙은 RFC 3339 날짜시간으로, UTC로 변환되고 시작 포함·끝 제외인 `[from, to)`이며 최대 366일입니다. **단계**(`steps`, 순서대로). 세 단계는 모두 같은 값, 즉 기록이 처음 만들어진 시점(`firstViewedAt`)으로 한정됩니다. 방문자의 경우 해당 브라우저의 첫 방문 시각이고, 제출의 경우 제출 시각입니다. 각 단계는 `[from, to)` 안에서 만들어진 기록 수를 셉니다. 각 단계는 기간으로 한정됩니다. - `visited`: 기간 안에 처음 확인된 서로 다른 방문자(브라우저당 하나). 기간 이전에 처음 와서 기간 안에 다시 방문한 사람은 집계되지 않습니다. - `clicked_submit`: 그 방문자 중 제출 또는 결제 버튼을 한 번 이상 누른 사람. - `submitted`: 기간 안의 제출 수. 이메일 주소가 있는 첫 제출마다 기록이 하나 만들어지며, 같은 이메일로 다시 제출해도 다시 집계되지 않습니다. 리드가 아직 남아 있는 제출만 집계합니다. 나중에 리드가 삭제된 제출은 집계되지 않습니다. **단계는 서로 독립적인 집계이며 연결된 코호트가 아닙니다.** 방문자의 방문과 같은 사람의 제출은 서로 연결되지 않은 별개의 기록이며, 각각 만들어진 기간에 집계됩니다. 따라서 `visited`, `clicked_submit`, `submitted`는 같은 사람들을 나타내지 않으며, 기간 이전에 방문했다가 기간 안에 제출한 사람은 `submitted`에만 더해집니다. 각 단계에는 `count`와 `conversionFromPrevious`(`count`를 이전 단계의 `count`로 나눈 값, 소수점 4자리, 첫 단계는 `null`, 이전 단계가 비어 있으면 `0`)가 있습니다. 이 때문에, 그리고 추적된 클릭을 거치지 않은 제출(예: 직접 입력한 제출)은 `submitted`에만 집계되므로 `conversionRate`와 같은 주의사항으로 1로 제한되지 않습니다. **그 밖의 필드.** - `conversionRate`: `submitted / visited`, 소수점 4자리(`0.25` = 25%), 방문자가 없으면 `0`. - `dropOff`: `clicked_submit - submitted`이며 0 미만이 되지 않습니다. 단계와 같은 집계 방식으로, 제출 또는 결제 버튼을 눌렀지만 완료하지 않은 사람입니다. 이 두 단계만 사용합니다. - 페이지 로드 합계는 여기에 없습니다. 기간 안의 페이지 로드는 `GET /documents/{id}/analytics`의 `views`를 사용하세요. - 테스트 및 소유자 기록은 제외됩니다. 폼의 평균 체류 시간은 반환하지 않습니다. 집계 수치만 제공합니다. 방문자, 이메일, 전화번호, 응답 데이터는 없습니다. 알 수 없거나 반복된 쿼리 파라미터(`compare` 포함)는 `400 VALIDATION_ERROR`로 거부됩니다. operationId: getFormFunnel parameters: - name: from in: query required: true description: 기간 시작(포함). `Z` 또는 숫자 오프셋이 붙은 RFC 3339. schema: type: string format: date-time example: '2026-10-01T00:00:00Z' - name: to in: query required: true description: 기간 끝(제외). `Z` 또는 숫자 오프셋이 붙은 RFC 3339. `from`으로부터 최대 366일 이내. schema: type: string format: date-time example: '2026-10-08T00:00:00Z' responses: '200': description: 해당 기간의 퍼널. content: application/json: schema: $ref: '#/components/schemas/FormFunnel' example: documentId: 7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90 from: '2026-10-01T00:00:00.000Z' to: '2026-10-08T00:00:00.000Z' steps: - step: visited count: 96 conversionFromPrevious: null - step: clicked_submit count: 41 conversionFromPrevious: 0.4271 - step: submitted count: 33 conversionFromPrevious: 0.8049 conversionRate: 0.3438 dropOff: 8 '400': description: | `VALIDATION_ERROR`: `from` 또는 `to` 누락, `Z`나 오프셋이 있는 RFC 3339 날짜시간이 아님, `from`이 `to`보다 늦음, 366일을 넘는 기간, 알 수 없거나 반복된 쿼리 파라미터. 같은 요청을 그대로 재시도해도 성공하지 않습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': $ref: '#/components/responses/Unauthorized' '403': description: > `INSUFFICIENT_SCOPE`(키에 `analytics:read`가 없음), `PLAN_REQUIRED`, `PAST_DUE_RESTRICTED` 중 하나입니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': $ref: '#/components/responses/DocumentNotFound' '422': description: | `NOT_A_FORM_DOCUMENT`: 내 문서이지만 폼이 아닙니다. 같은 요청을 그대로 재시도해도 성공하지 않습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/RateLimited' '500': description: '`INTERNAL_ERROR`: 예기치 않은 오류. 재시도 가능하며 원인은 반환되지 않습니다.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/Unavailable' security: - apiKey: [] x-codeSamples: - lang: bash label: curl source: > curl -G "https://docurise.io/api/preview/documents/7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90/analytics/funnel" \ -H "Authorization: Bearer $DOCURISE_API_KEY" \ --data-urlencode "from=2026-10-01T00:00:00Z" \ --data-urlencode "to=2026-10-08T00:00:00Z" components: schemas: FormFunnel: type: object required: - documentId - from - to - steps - conversionRate - dropOff properties: documentId: type: string format: uuid description: 집계 대상 폼의 id입니다. from: type: string format: date-time description: 요청한 기간의 시작, UTC(포함). to: type: string format: date-time description: 요청한 기간의 끝, UTC(제외). steps: type: array description: 항상 세 단계가 순서대로 들어 있습니다. 기간 안에 만들어진 기록의 독립적인 집계이며 연결된 코호트가 아닙니다. items: $ref: '#/components/schemas/FunnelStep' conversionRate: type: number description: submitted / visited, 소수점 4자리. 방문자가 없으면 0. 1을 넘을 수 있습니다. dropOff: type: integer description: '`clicked_submit` 빼기 `submitted`, 0 미만 없음.' ErrorResponse: type: object required: - error properties: error: type: object required: - code - message - retryable properties: code: type: string description: 안정적인 기계 판독용 에러 코드입니다 — `message`가 아니라 이 값을 기준으로 분기하세요. message: type: string description: 사람이 읽을 수 있는 상세 설명입니다. 예고 없이 문구가 바뀔 수 있습니다. retryable: type: boolean description: 동일한 요청을 재시도했을 때 성공할 가능성이 있는지 여부입니다. retryAfterSeconds: type: integer description: 구체적인 백오프 힌트가 있는 경우에만 존재합니다. details: type: object description: > 일부 특정 코드에만 존재합니다: - `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, 요청을 거부한 보호 규칙입니다 (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` 또는 `form_no_access_controls`). 열려 있는 값입니다. 새 값을 허용하세요. - `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, 이미 있는 "다음 게시물" 규칙입니다. - `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, 다음 중 하나입니다: `NOTION_ERROR_PRIVATE`, `NOTION_ERROR_NOT_FOUND`, `NOTION_ERROR_NETWORK`, `NOTION_ERROR_RATE_LIMIT`, `NOTION_ERROR_TEMPORARILY_UNAVAILABLE`, `NOTION_ERROR_PAGE_REJECTED`, `NOTION_ERROR_UNKNOWN`. - `HTML_REJECTED`: `{ reason: string }`, `too_large`, `css_rejected`, `invalid` 중 하나입니다. 열려 있는 값입니다. 새 값을 허용하세요. - `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, 받지 않는 조건 타입과 그 조건이 요청에서 있는 위치입니다. 그 위치에서 거부된 조건 형태에는 `operator: string`이, `requiredConditions`에서 대신 쓸 수 있는 연산자가 있으면 `invertTo: string`도 더해집니다. - `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, 알 수 없는 id가 요청에서 있는 위치와 그 id가 가리키는 대상(`document`, `product`, `tier`, `cta`, `folder`, `broadcast`, `step`)입니다. 열려 있는 값입니다. 새 값을 허용하세요. - `TAG_NOT_FOUND`(그룹 규칙에서): `{ tag: string }`, 존재하지 않는 태그 이름입니다. - `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, 계정에 없는 그룹 id입니다. - `GROUP_LIMIT_REACHED`: `{ limit: integer }`, API로 계정이 만들 수 있는 그룹의 최대 개수입니다. description: >- 오류 정보입니다. API의 모든 오류 응답에 들어 있으며 `code`, `message`, `retryable`을 담고, 일부 코드에는 `retryAfterSeconds`와 `details`도 담깁니다. FunnelStep: type: object required: - step - count - conversionFromPrevious properties: step: type: string enum: - visited - clicked_submit - submitted description: >- `visited`는 범위 안에서 폼을 처음 연 고유 브라우저, `clicked_submit`은 그중 제출 버튼을 누른 수, `submitted`는 범위 안에서 리드가 생성된 고유 연락처(직접 추가한 리드 포함)입니다. count: type: integer description: 범위 안에서 이 단계에 해당하는 기록 수입니다. conversionFromPrevious: type: - number - 'null' description: >- count / 이전 단계의 count, 소수점 4자리. 첫 단계는 `null`, 이전 단계가 비어 있으면 0. 단계가 독립적인 집계이므로 1을 넘을 수 있습니다. responses: Unauthorized: description: '누락되었거나 형식이 잘못되었거나 폐기된 API 키입니다(`code: UNAUTHORIZED`).' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' DocumentNotFound: description: | `DOCUMENT_NOT_FOUND`: 이 계정에 해당하는 문서가 없습니다(알 수 없는 ID, 잘못된 형식의 ID, 다른 사람의 ID는 모두 구분되지 않습니다). API를 사용할 수 없는 계정이면 `NOT_FOUND`입니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: >- 속도 제한에 걸렸습니다 (`code: RATE_LIMITED`, 항상 재시도 가능): `Retry-After` 헤더와 `X-RateLimit-*` 헤더를 참고하세요. 또는 동시에 실행 중인 요청이 너무 많습니다 (`code: TOO_MANY_CONCURRENT_REQUESTS`, 항상 재시도 가능): `Retry-After`는 `1`이고 `X-RateLimit-*` 헤더는 없습니다. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer description: 제한이 초기화되는 유닉스 타임스탬프(초)입니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unavailable: description: | 서버 측 의존성이 일시적으로 다운되었습니다(`RATE_LIMIT_UNAVAILABLE` 또는 `SERVICE_UNAVAILABLE`). 요청이나 키의 문제가 아니며, 항상 재시도 가능합니다 — `retryAfterSeconds`가 있으면 그에 따르세요. 그룹 엔드포인트(`POST /segments`, `POST /segments/preview`, `GET /segments/{id}`)는 매우 무거운 규칙의 인원을 약 10초 안에 셀 수 없을 때도 이 코드를 반환합니다. 규칙을 단순하게 만들거나 다시 시도하세요. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: apiKey: type: http scheme: bearer bearerFormat: dr_live__ description: | Settings → Developers에서 발급한 키를 `Authorization: Bearer dr_live_<12자리 16진수>_<64자리 16진수>` 형태로 전송합니다. 키는 명시적인 범위를 가지며 — 각 엔드포인트에 필요한 범위가 해당 엔드포인트에 명시되어 있습니다. 전체 키는 발급 시점에 딱 한 번만 표시되며 다시 조회할 수 없습니다 — 이후에는 `keyId` 접두어만 표시됩니다. 폐기된 키는 바로 다음 요청부터 인증에 실패합니다. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.