> ## 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. # Get form funnel > Visit, submit-click and submission counts, with conversion between steps, for one of your forms over a UTC date range ## OpenAPI ````yaml api-reference/openapi.yaml GET /api/preview/documents/{id}/analytics/funnel openapi: 3.1.0 info: title: DocuRise Public API version: preview description: > Programmatic access to DocuRise. **This is a preview API.** Every path is versioned under `/api/preview/` and carries no compatibility guarantee while it is in preview: fields, values and error codes may be added, changed or removed. Once the contract stabilizes it will be promoted to `/api/v1/`. See the [changelog](/changelog) for what changed and when. ### Access Every route requires: 1. A valid API key (see Authentication below). 2. The calling account's plan must be **Iconic or above**. 3. During the preview the API is available to some accounts only, whatever the plan. Accounts without access get a `404` from every route below; if you expect access, check with your DocuRise contact. Generate and manage keys from **Settings → Developers** in the dashboard. ### Idempotency `POST` endpoints that create a resource require an `Idempotency-Key` header. Reusing the same key with the same request body replays the original response (same status code, same body) instead of creating a second resource — safe to retry on timeout or connection loss. A key is remembered for 7 days; after that the same key is treated as a new request. Reusing the same key with a **different** body is rejected with `IDEMPOTENCY_KEY_CONFLICT`. Generate a fresh key (a UUID or ULID is fine) per logical operation, not per HTTP attempt. One exception: `POST /api/preview/tags` takes no `Idempotency-Key`. Creating the same tag name twice changes nothing (the second call returns the existing tag with `created: false`), so a retry is always safe. Another exception: `POST /api/preview/segments/preview` takes no `Idempotency-Key`. It saves nothing, so repeating it is always safe. ### Response compatibility Responses may gain additional fields over time, and `type`/`code`-style enum values (for example a future `LeadFormQuestion.type` member, or a new error `code`) may gain new members. Always ignore fields and enum values you don't recognize rather than treating them as errors — this is what makes every additive change under `preview` non-breaking. A field absent from a response is not always the same as a field present with value `null`. A field whose type never includes `null` is omitted when it doesn't apply — it is never sent as `null` (for example, `retryAfterSeconds` is left out entirely when there's no backoff hint, not set to `null`). A field whose type explicitly allows `null` uses it to mean something real and distinct from "not present" (for example, `expiresAt: null` on a document means it has no fixed expiry date, not "unknown" or "not applicable"). All field names use `camelCase` — `notionUrl`, `leadFormQuestions`, `collectName`, and so on — consistently across every request and response body. ### Identifiers `id` values are opaque strings. Store and compare them as unstructured tokens — don't parse them, validate their format, or assume anything about their length or character set. ### Errors Every error response has the same shape: ```json { "error": { "code": "STRING", "message": "human-readable", "retryable": false } } ``` Switch on `code`, not `message` — `message` is free text for logs/debugging and may be reworded without notice; `code` is the stable contract. `retryable` tells you whether the same request is safe to retry as-is; when present, `retryAfterSeconds` is a concrete backoff hint. A request body that contains a NUL character (`\u0000`), in a string value or in a property name, is refused with `400 VALIDATION_ERROR` before anything is saved. ### Rate limiting 60 requests/minute per account across all `/api/preview/*` routes, regardless of how many keys that account has. Exceeding it returns `429` with a `Retry-After` header. Separately, an account can have at most 10 requests running at the same moment across these routes, however many keys it has. A request that would be the eleventh returns `429` with `code: TOO_MANY_CONCURRENT_REQUESTS` and `Retry-After: 1`; wait for one of your requests to finish and retry. This limit counts requests that have not finished, so it can apply even while you are under 60 requests per minute. contact: name: DocuRise url: https://docurise.io servers: - url: https://docurise.io description: Production security: - apiKey: [] tags: - name: Documents description: >- Create documents (a Notion page, a post or a lead-capture form), list or read the documents you own, publish drafts, and change their status, expiry and email protection. - name: Analytics description: >- Read aggregate view, visitor, lead and conversion numbers for one of your documents, split by traffic channel, compared with the previous period, or as a form funnel, and rank all of your documents by views, visitors or leads. - name: Folders description: Read your folders and courses, with item counts. - name: Products description: Read your product catalog (read-only). - name: Audiences description: >- List your tags and groups with contact counts, create a group from a rule, count who a rule would match, and read one group with its rule. Counts only; no member data is ever returned. - name: Contacts description: >- Add or remove a tag on one of your contacts. Contact details are never returned. - name: Email description: >- Read email broadcasts, their aggregate delivery numbers, and automations. Email only; Kakao is not included. - name: Instagram description: >- Create, read, edit, pause and resume Instagram comment-to-DM automation rules. - name: Account description: Inspect the API key you are calling with. paths: /api/preview/documents/{id}/analytics/funnel: parameters: - name: id in: path required: true description: The id of a form document. schema: type: string format: uuid get: tags: - Analytics summary: Get form funnel description: | Returns the conversion funnel of one of your **form** documents over a date range: how many people visited, how many clicked the submit or pay button, and how many submitted, with the conversion between steps. Needs the `analytics:read` scope. A document that does not exist or is not yours is a `404 DOCUMENT_NOT_FOUND`, never a `403`. A document of yours that is not a form (a Notion page, PDF, upload or post) is `422 NOT_A_FORM_DOCUMENT`; for those use `GET /documents/{id}/analytics`. **Range.** Same as `GET /documents/{id}/analytics`: `from` and `to` are required RFC 3339 datetimes with `Z` or a numeric offset, converted to UTC, start-inclusive and end-exclusive `[from, to)`, at most 366 days. **Steps** (`steps`, in order). All three steps are bounded by the same value: the moment the record was first created (`firstViewedAt`), which is the first visit of that browser for a visitor, and the submission time for a submission. A step counts the records created in `[from, to)`. Each step is limited to the range. - `visited`: distinct visitors (one per browser) first seen in the range. A visitor who first came before the range and returned inside it is not counted. - `clicked_submit`: those visitors who clicked the submit or pay button at least once. - `submitted`: submissions in the range. Each first submission with an email address creates one record; a second submission with the same email is not counted again. Only submissions whose lead still exists are counted: a submission whose lead was later deleted is not counted. **The steps are independent counts, not a linked cohort.** A visitor's visit and the same person's submission are separate records that are not linked, and each is counted in the range in which it was created. So `visited`, `clicked_submit` and `submitted` do not describe the same people, and a person who visited before the range and submitted inside it adds to `submitted` only. Each step has `count` and `conversionFromPrevious` (`count` divided by the previous step's count, 4 decimals, `null` for the first step, `0` when the previous step is empty). It is not capped at 1 (the same caveat as `conversionRate`), for that reason and because a submission that never went through a tracked click (for example one you entered by hand) is counted in `submitted` only. **Other fields.** - `conversionRate`: `submitted / visited`, 4 decimals (`0.25` = 25%), `0` with no visitors. - `dropOff`: `clicked_submit - submitted`, never below 0: those who clicked submit or pay and did not complete, in the same counting sense as the steps. It uses only those two steps. - There is no page-load total here. For page loads in a range use `views` from `GET /documents/{id}/analytics`. - Test and owner records are excluded. The average time on the form is not returned. Counts only: no visitor, email, phone or answer data. Unknown or repeated query parameters (including `compare`) are rejected with `400 VALIDATION_ERROR`. operationId: getFormFunnel parameters: - name: from in: query required: true description: >- Start of the range, inclusive. RFC 3339 with `Z` or a numeric offset. schema: type: string format: date-time example: '2026-10-01T00:00:00Z' - name: to in: query required: true description: >- End of the range, exclusive. RFC 3339 with `Z` or a numeric offset. At most 366 days after `from`. schema: type: string format: date-time example: '2026-10-08T00:00:00Z' responses: '200': description: The funnel for the range. 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` or `to` missing, not an RFC 3339 datetime with `Z` or an offset, `from` after `to`, a range longer than 366 days, or an unknown or repeated query parameter. Never retryable as sent. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': $ref: '#/components/responses/Unauthorized' '403': description: | One of `INSUFFICIENT_SCOPE` (the key lacks `analytics:read`), `PLAN_REQUIRED` or `PAST_DUE_RESTRICTED`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': $ref: '#/components/responses/DocumentNotFound' '422': description: | `NOT_A_FORM_DOCUMENT`: the document is yours but is not a form. Never retryable as sent. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/RateLimited' '500': description: >- `INTERNAL_ERROR`: unexpected failure. Retryable; the cause is not returned. 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: The id of the form the numbers are for. from: type: string format: date-time description: Start of the range as requested, in UTC (inclusive). to: type: string format: date-time description: End of the range as requested, in UTC (exclusive). steps: type: array description: >- Always the three steps, in order. Independent counts of records created in the range, not a linked cohort. items: $ref: '#/components/schemas/FunnelStep' conversionRate: type: number description: submitted / visited, 4 decimals; 0 with no visitors; can exceed 1. dropOff: type: integer description: '`clicked_submit` minus `submitted`, never below 0.' ErrorResponse: type: object required: - error properties: error: type: object required: - code - message - retryable properties: code: type: string description: >- Stable machine-readable error code — switch on this, not `message`. message: type: string description: Human-readable detail. May change wording without notice. retryable: type: boolean description: Whether retrying the identical request may succeed. retryAfterSeconds: type: integer description: Present only when a concrete backoff hint applies. details: type: object description: > Present only for a few specific codes: - `PROTECTION_RULE_CONFLICT`: `{ rule: string }`, the protection rule that refused the request (`form`, `restricted_access`, `paid_lead_gate`, `free_lead_gate` or `form_no_access_controls`). Open-ended: tolerate new values. - `NEXT_POST_RULE_EXISTS`: `{ ruleId: string }`, the existing next-post rule. - `NOTION_FETCH_FAILED`: `{ notionErrorCode: string }`, one of `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 }`, one of `too_large`, `css_rejected` or `invalid`. Open-ended: tolerate new values. - `CONDITION_NOT_SUPPORTED`: `{ field: string, path: string }`, the condition type that is not accepted and where it sits in the request. For a condition shape refused where it sits also `operator: string` and, when there is an equivalent operator for `requiredConditions`, `invertTo: string`. - `REFERENCE_NOT_FOUND`: `{ path: string, kind: string }`, where the unknown id sits in the request and what it refers to: `document`, `product`, `tier`, `cta`, `folder`, `broadcast` or `step`. Open-ended: tolerate new values. - `TAG_NOT_FOUND` (from a group rule): `{ tag: string }`, the tag name that does not exist. - `GROUP_REFERENCE_NOT_FOUND`: `{ groupIds: string[] }`, the group ids that are not in the account. - `GROUP_LIMIT_REACHED`: `{ limit: integer }`, the most groups an account can create through the API. description: >- The error. Every error response from the API has it: `code`, `message`, `retryable` and, for some codes, `retryAfterSeconds` and `details`. FunnelStep: type: object required: - step - count - conversionFromPrevious properties: step: type: string enum: - visited - clicked_submit - submitted description: >- `visited`: distinct browsers that first opened the form in the range. `clicked_submit`: those that pressed submit. `submitted`: distinct contacts whose lead was created in the range (including leads added by hand). count: type: integer description: Records for this step in the range. conversionFromPrevious: type: - number - 'null' description: >- count / the previous step's count, 4 decimals; `null` for the first step; 0 when the previous step is empty; can exceed 1 because the steps are independent counts. responses: Unauthorized: description: 'Missing, malformed, or revoked API key (`code: UNAUTHORIZED`).' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' DocumentNotFound: description: | `DOCUMENT_NOT_FOUND`: no such document for this account (unknown, malformed or someone else's id, all indistinguishable). Or `NOT_FOUND` if the API is not available to the account. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: >- Rate limited (`code: RATE_LIMITED`, always retryable): see the `Retry-After` header and `X-RateLimit-*` headers. Or too many requests running at once (`code: TOO_MANY_CONCURRENT_REQUESTS`, always retryable): `Retry-After` is `1` and there are no `X-RateLimit-*` headers. 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: Unix timestamp (seconds) when the limit resets. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unavailable: description: | A server-side dependency is temporarily down (`RATE_LIMIT_UNAVAILABLE` or `SERVICE_UNAVAILABLE`). Not a problem with the request or key; always retryable — honor `retryAfterSeconds` when present. The group endpoints (`POST /segments`, `POST /segments/preview`, `GET /segments/{id}`) also return it when a very heavy rule could not be counted within about 10 seconds: simplify the rule or retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: apiKey: type: http scheme: bearer bearerFormat: dr_live__ description: | A key generated from Settings → Developers, sent as `Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>`. Keys carry explicit scopes — each endpoint states the one it requires. The full key is shown exactly once at generation time and cannot be retrieved again; only the `keyId` prefix is shown afterward. A revoked key fails auth on its very next request. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.