> ## Documentation Index > Fetch the complete documentation index at: https://docs.tagada.io/llms.txt > Use this file to discover all available pages before exploring further. # Track funnel step event > Track funnel step events for analytics and conversion tracking. Supports multiple event types: - **view**: Step page was viewed (impression) - **enter**: User navigated to the step - **convert**: User completed a conversion goal (e.g., purchase) - **custom**: Custom event within the funnel Works with both: - **Native funnel system**: Include funnelId and funnelSessionId - **Standalone pages**: Include url for page context ## OpenAPI ````yaml /openapi.json post /api/public/v1/funnel-tracking/step openapi: 3.0.3 info: title: TagadaPay API description: >- # TagadaPay API Documentation Welcome to the TagadaPay API. This REST API lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically. ## Authentication Authenticate every request with a Bearer token. Get your API key from the [TagadaPay Dashboard](https://app.tagada.io). ``` Authorization: Bearer your-api-key ``` All requests must be made over HTTPS with `Content-Type: application/json`. ## Rate Limits | Plan | Requests/min | Burst | |------|-------------|-------| | Standard | 100 | 150 | | Premium | 500 | 750 | Exceeding the limit returns `429 Too Many Requests`. ## Errors | Code | Meaning | |------|---------| | 400 | Bad request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient permissions | | 404 | Not found | | 409 | Conflict | | 429 | Rate limited | | 500 | Server error | ## Support - Email: api-support@tagada.io - Docs: [docs.tagadapay.com](https://docs.tagadapay.com) version: 1.0.0 servers: - url: https://api.tagada.io/ description: Production - url: https://api.tagada.dev/ description: Sandbox / Development security: - bearerAuth: [] tags: - name: auth description: Test your API key and verify authentication. - name: stores description: Create and manage stores within your account. - name: products description: Create products with variants, prices, and currency options. - name: customers description: Manage customer records, addresses, and payment instruments. - name: orders description: List and retrieve orders with line items, payments, and metadata. - name: payments description: Process, list, refund, void, and dispute payments. - name: subscriptions description: >- Create and manage recurring subscriptions — billing, cancellation, rebilling, and processor changes. - name: payment-flows description: Configure payment routing strategies with cascading processor fallbacks. - name: payment-instruments description: >- Manage stored payment methods — cards, bank accounts, and tokenized instruments. - name: processors description: List connected payment processors (Stripe, NMI, Checkout.com, etc.). - name: promotions description: Create and manage discount promotions with rules and conditions. - name: promotion-codes description: Generate and manage reusable promotion/coupon codes. - name: block-rules description: >- Configure fraud prevention rules to block transactions by IP, email, card BIN, country, etc. - name: webhooks description: Register webhook endpoints to receive real-time event notifications. - name: events description: Query application events, statistics, and audit logs. - name: domains description: Add, verify, and manage custom domains for your checkout and funnels. - name: funnels description: >- Create and manage checkout funnels with routing, A/B testing, and CDN deployment. - name: funnel-sessions description: Retrieve funnel session data for analytics and debugging. - name: funnel-tracking description: Track funnel step events for conversion analytics. - name: plugins description: Deploy, manage, and configure checkout plugins. - name: plugins-v2 description: >- V2 plugin system — deploy, mount, split-test, fork, promote, and manage plugin instances. - name: checkout description: >- Initialize checkout sessions and process payments through the hosted checkout. - name: 3ds description: >- 3D Secure authentication — create sessions, authenticate, and handle challenges. - name: builder description: Generate and validate builder session tokens for the visual page editor. - name: health description: API health check endpoint. - name: test description: Test and debugging utilities for the event system (sandbox only). paths: /api/public/v1/funnel-tracking/step: post: tags: - funnel-tracking summary: Track funnel step event description: |- Track funnel step events for analytics and conversion tracking. Supports multiple event types: - **view**: Step page was viewed (impression) - **enter**: User navigated to the step - **convert**: User completed a conversion goal (e.g., purchase) - **custom**: Custom event within the funnel Works with both: - **Native funnel system**: Include funnelId and funnelSessionId - **Standalone pages**: Include url for page context operationId: post-api-public-v1-funnel-tracking-step parameters: [] requestBody: required: true content: application/json: schema: type: object properties: eventType: type: string enum: - view - enter - convert - custom storeId: type: string stepId: type: string stepName: type: string stepType: type: string stepIndex: type: number isEntryStep: type: boolean isConversionStep: type: boolean customerId: type: string funnelId: type: string funnelSessionId: type: string funnelName: type: string fromStepId: type: string fromStepType: type: string url: type: string referrer: type: string pageTitle: type: string userAgent: type: string deviceType: type: string enum: - mobile - tablet - desktop orderId: type: string orderAmount: type: number orderCurrency: type: string transactionId: type: string totalStepsVisited: type: number entryStepId: type: string pathTaken: type: array items: type: string sessionDurationMs: type: number source: type: string medium: type: string campaign: type: string content: type: string term: type: string customEventName: type: string customEventProperties: type: object additionalProperties: {} environment: type: string enum: - staging - production isPreview: type: boolean draft: type: boolean funnelTracking: type: boolean default: true metadata: type: object additionalProperties: {} required: - eventType - storeId - stepId additionalProperties: false examples: trackStepView: summary: Track step view (native funnel) value: eventType: view storeId: store_123 stepId: step_checkout stepName: Checkout stepType: checkout funnelId: funnelv2_123 funnelSessionId: fs_1234567890_abc123 customerId: cus_123 isEntryStep: true trackStepEnter: summary: Track step enter with navigation value: eventType: enter storeId: store_123 stepId: step_offer stepName: Upsell Offer stepType: offer funnelId: funnelv2_123 funnelSessionId: fs_1234567890_abc123 customerId: cus_123 fromStepId: step_checkout fromStepType: checkout trackConversion: summary: Track conversion (purchase) value: eventType: convert storeId: store_123 stepId: step_thankyou stepName: Thank You stepType: thankyou funnelId: funnelv2_123 funnelSessionId: fs_1234567890_abc123 customerId: cus_123 isConversionStep: true orderId: order_abc123 orderAmount: 9999 orderCurrency: USD totalStepsVisited: 3 entryStepId: step_checkout sessionDurationMs: 180000 source: google medium: cpc campaign: summer_sale trackStandaloneView: summary: Track standalone page view (no funnel) value: eventType: view storeId: store_123 stepId: landing_page_1 stepName: Landing Page stepType: landing url: https://example.com/landing referrer: https://google.com anonymousId: anon_xyz789 deviceType: mobile trackCustomEvent: summary: Track custom event value: eventType: custom storeId: store_123 stepId: step_checkout customEventName: add_to_cart_clicked customEventProperties: productId: prod_123 quantity: 2 customerId: cus_123 funnelSessionId: fs_1234567890_abc123 responses: '200': description: Successful response content: application/json: schema: {} examples: success: summary: Event tracked value: success: true eventType: view stepId: step_checkout default: $ref: '#/components/responses/error' security: - bearerAuth: [] components: responses: error: description: Error response content: application/json: schema: type: object properties: message: type: string code: type: string issues: type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your API key as: `Bearer your-api-key`' ````