Objects
/
Funnel

Funnel

Funnel object representing a conversion funnel in LiveSession. Tracks user progression through defined steps in your application. Used for analyzing user journey and conversion rates.

Fields

    funnel_id
    ID!
    Required
    Unique identifier for the funnel. Used for referencing and managing the funnel.
    created_by_agent_id
    String!
    Required
    ID of the agent who created the funnel. Used for tracking funnel ownership and permissions.
    created_by_login
    String!
    Required
    Login of the user who created the funnel. Used for display and audit purposes.
    website_id
    ID!
    Required
    Associated website identifier. Links the funnel to a specific website in your account.
    name
    String!
    Required
    Display name of the funnel. Used for identification in the UI and API.
    description
    String!
    Required
    Detailed description of the funnel's purpose and configuration. Helps other team members understand the funnel's intent.
    segment_id
    String!
    Required
    Associated segment identifier for filtering data. Links the funnel to a specific user segment.
    compute
    ComputeFunnel
    Computation settings and results for the funnel. Contains the configuration and analysis results.
    is_favourite
    Boolean!
    Required
    Whether the funnel is marked as favorite. Used for quick access and organization.
    is_owner
    Boolean!
    Required
    Whether the current user owns this funnel. Used for permission management.
    is_public
    Boolean!
    Required
    Whether the funnel is publicly accessible. Controls visibility across your organization.
Built with

Show your support! Star us on GitHub ⭐️