Funnel types

This list contains all query types for the funnel endpoints.


Funnel

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the funnel.

  • Name
    uid
    Type
    ID!
    Description

    Unique identifier for the funnel.

  • Name
    _id
    Type
    Int!
    Description

    Unique numeral identifier for the funnel.

  • Name
    name
    Type
    String
    Description

    The funnel name.

  • Name
    slug
    Type
    String
    Description

    The funnel slug.

  • Name
    starting_step_id
    Type
    Int
    Description

    The funnel starting step id.

  • Name
    published
    Type
    Boolean!
    Description

    The funnel published option.

  • Name
    record
    Type
    Boolean!
    Description

    The funnel record option.

  • Name
    enable_address_autocomplete
    Type
    Boolean!
    Description

    The funnel enable address autocomplete option.

  • Name
    fire_lead_insteadof_purchase
    Type
    Boolean!
    Description

    The funnel fire lead instead of purchase option.

  • Name
    managed
    Type
    Boolean!
    Description

    The funnel managed option.

  • Name
    share_code
    Type
    String
    Description

    The funnel share code.

  • Name
    styles
    Type
    [InputStepStyle!]
    Description

    The funnel styles.

    input InputStepStyle {
    	key: String!
    	name: String!
    	type: String!
    	value: FunnelStyleValue
    }
    
    scalar FunnelStyleValue
    
  • Name
    active_payment_methods
    Label
    [FunnelPaymentGateway!]!
    Description

    The funnel active payment method.

  • Name
    active_facebook_pixels
    Type
    [String!]!
    Description

    The funnel active facebook pixels.

  • Name
    active_tiktok_pixels
    Type
    [String!]!
    Description

    The funnel active tiktok pixels.

  • Name
    active_snapchat_pixels
    Type
    [String!]!
    Description

    The funnel active snapchat pixels.

  • Name
    activate_google_analytics
    Type
    Boolean!
    Description

    The funnel activate google analytics option.

  • Name
    transform
    Type
    Transform!
    Description

    The funnel transform.

    type Transform {
    	y: Float!
    	x: Float!
    	k: Float!
    }
    
  • Name
    instructions
    Type
    [Instruction!]!
    Description

    The funnel instructions.

    scalar Instruction
    
  • Name
    updated_at
    Type
    TimeStamp!
    Description

    Timestamp of when the funnel was updated.

    Arguments

  • Name
    format
    Type
    String
    Description

    The supported format parameters: fromNow YYYY-MM-DD HH:mm:ss

  • Name
    suffix
    Type
    Boolean
    Description

    TimeStamp suffix

  • Fields

    scalar TimeStamp

  • Name
    created_at
    Type
    TimeStamp!
    Description

    Timestamp of when the funnel was created.

  • Name
    meta
    Type
    FunnelMeta!
    Description

    The funnel meta.

    type FunnelMeta {
    	template_style_id: Int
    }
    
  • Name
    favicon_id
    Type
    Int
    Description

    The funnel favicon id.

  • Name
    preferred_domain
    Label
    Domain
    Description

    The funnel preferred domain.

  • Name
    favicon
    Label
    Image
    Description

    The funnel favicon.

  • Name
    default_language
    Type
    FunnelLanguage
    Description

    The funnel default language.

    enum FunnelLanguage {
    	ar
    	en
    	fr
    	it
    	es
    	bp
    	pt
    	hi
    	nl
    	de
    	sv
    	ru
    	he
    }
    
  • Name
    steps
    Label
    [Step!]!
    Description

    The funnel steps.

  • Name
    statistics
    Type
    FunnelStatistics!
    Description

    The funnel statistics.

    type FunnelStatistics {
    	steps: [StepStatistics!]!
    }
    
    type StepStatistics {
    	id: String!
    	visits: Int!
    	clicks: Int!
    	ctr: Float!
    	links: [StepLink!]!
    }
    
    type StepLink {
    	id: String!
    	ctr: Float!
    	visits: Int!
    	cvr: Float!
    }
    
  • Name
    header_scripts
    Type
    String
    Description

    The funnel header scripts.

  • Name
    ignore_invalide_phones
    Type
    Boolean!
    Description

    The funnel ignore invalid phones option.

Request

POST
https://api.lightfunnels.com/graphql
query FunnelsQuery($first: Int, $after: String, $query: String!){
	funnels(query: "order_by:id order_dir:desc", after: "WzVE4OTA5LDEe/4OTA5XQ==", first: 10){
		edges{
			node{
				id
				_id
				name
				published
				slug
				created_at
				...
			}
		}
	}
}

InputCreateFunnel

Fields

  • Name
    name
    Type
    String!
    Description

    The funnel name.

  • Name
    slug
    Type
    String!
    Description

    The funnel slug.

  • Name
    product_id
    Type
    Int
    Description

    The funnel product id.

  • Name
    style_id
    Type
    Int
    Description

    The funnel style id.

  • Name
    funnel_steps
    Type
    [StepType!]!
    Description

    The funnel steps.

    enum StepType {
    	blank_page
    	product_page
    	checkout_page
    	upsell_page
    	downsell_page
    	split_test
    	article_page
    	squeeze_page
    	thank_you_page
    	generic_page
    }
    

Request

POST
https://api.lightfunnels.com/graphql
mutation mutationName($node: InputCreateFunnel! {
	createFunnel(node: $node){
		# Funnel type fields
	}
}

InputFunnel

Fields

  • Name
    name
    Type
    String
    Description

    The funnel name.

  • Name
    slug
    Type
    String
    Description

    The funnel slug.

  • Name
    starting_step_id
    Type
    Int
    Description

    The funnel starting step id.

  • Name
    favicon_id
    Type
    Int
    Description

    The funnel favicon id.

  • Name
    steps
    Label
    [InputStep]
    Description

    The funnel steps.

  • Name
    deleted_steps
    Type
    [Int!]
    Description

    The funnel deleted steps.

  • Name
    published
    Type
    Boolean
    Description

    The funnel published option.

  • Name
    record
    Type
    Boolean
    Description

    The funnel record option.

  • Name
    fire_lead_insteadof_purchase
    Type
    Boolean
    Description

    The funnel fire lead instead of purchase option.

  • Name
    enable_address_autocomplete
    Type
    Boolean
    Description

    The funnel enable address autocomplete option.

  • Name
    header_scripts
    Type
    String
    Description

    The funnel header scripts.

  • Name
    preferred_domain_uid
    Type
    String
    Description

    The funnel preferred domain uid.

  • Name
    active_payment_methods2
    Type
    [ActivePaymentMethod!]
    Description

    The funnel active payment method.

    input ActivePaymentMethod {
    	settings: FunnelPaymentGatewaySettings!
    	id: Int!
    }
    
    scalar FunnelPaymentGatewaySettings
    
  • Name
    active_facebook_pixels
    Type
    [String!]
    Description

    The funnel active facebook pixels.

  • Name
    active_tiktok_pixels
    Type
    [String!]
    Description

    The funnel active tiktok pixels.

  • Name
    active_snapchat_pixels
    Type
    [String!]
    Description

    The funnel active snapchat pixels.

  • Name
    activate_google_analytics
    Type
    Boolean
    Description

    The funnel activate google analytics option.

  • Name
    transform
    Type
    InputTransform
    Description

    The funnel transform.

    input InputTransform {
    	y: Float!
    	x: Float!
    	k: Float!
    }
    
  • Name
    instructions
    Type
    [Instruction]
    Description

    The funnel instructions.

    scalar Instruction
    
  • Name
    styles
    Type
    [InputStepStyle!]
    Description

    The funnel styles.

    input InputStepStyle {
    	key: String!
    	name: String!
    	type: String!
    	value: FunnelStyleValue
    }
    
  • Name
    default_language
    Type
    FunnelLanguage
    Description

    The funnel default language.

    enum FunnelLanguage {
    	ar
    	en
    	fr
    	it
    	es
    	bp
    	pt
    	hi
    	nl
    	de
    	sv
    	ru
    	he
    }
    
  • Name
    ignore_invalide_phones
    Type
    Boolean
    Description

    The funnel ignore invalid phones option.

Request

POST
https://api.lightfunnels.com/graphql
mutation updateFunnelMutation($node: InputFunnel!, $id: Int!){
	updateFunnel(node: $node, id: $id){
		# Funnel type fields
	}
}

Domain

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the domain.

  • Name
    uid
    Type
    ID!
    Description

    Unique identifier for the domain.

  • Name
    _id
    Type
    Int!
    Description

    Unique numeral identifier for the domain.

  • Name
    name
    Type
    String!
    Description

    The domain name.

  • Name
    sends_emails
    Type
    Boolean!
    Description

    The domain sends emails option.

  • Name
    connected
    Type
    Boolean!
    Description

    The domain connected option.

  • Name
    ssl_connected
    Type
    Boolean!
    Description

    The domain ssl connected option.

  • Name
    require_actions
    Type
    Boolean!
    Description

    The domain require actions option.

  • Name
    redirect_to_primary
    Type
    Boolean!
    Description

    The domain redirect to primary option.

  • Name
    registrar
    Type
    String
    Description

    The domain registrar.

  • Name
    default_funnel_id
    Type
    Int
    Description

    The domain default funnel id.

  • Name
    default_funnel
    Type
    Funnel
    Description

    The domain default funnel.

  • Name
    updated_at
    Type
    TimeStamp!
    Description

    Timestamp of when the domain was updated.

  • Name
    created_at
    Type
    TimeStamp!
    Description

    Timestamp of when the domain was created.


FunnelPaymentGateway

Fields

  • Name
    index
    Type
    Int!
    Description

    The funnel index.

  • Name
    funnel_id
    Type
    Int!
    Description

    The funnel id.

  • Name
    payment_gateway_id
    Type
    Int!
    Description

    The funnel payment gateway id.

  • Name
    payment_gateway
    Label
    PaymentGateway!
    Description

    The funnel payment gateway.

  • Name
    settings
    Type
    FunnelPaymentGatewaySettings!
    Description

    The funnel product id.

    scalar FunnelPaymentGatewaySettings
    

PaymentGateway

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the payment gateway.

  • Name
    _id
    Type
    Int!
    Description

    Unique numeral identifier for the payment gateway.

  • Name
    type
    Type
    payment_gateway_type!
    Description

    The payment gateway type.

  • Name
    settings
    Type
    PaymentGatewaySettings!
    Description

    The payment gateway settings.

  • Name
    details
    Type
    PaymentGatewayDetails!
    Description

    The payment gateway details.

  • Name
    active
    Type
    Boolean!
    Description

    The payment gateway active option.

  • Name
    identifier
    Type
    String!
    Description

    The payment gateway identifier.

  • Name
    test
    Type
    Boolean!
    Description

    The payment gateway test option.

  • Name
    platform_active
    Type
    Boolean!
    Description

    The payment gateway platform active option.


Image

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the image.

  • Name
    _id
    Type
    Int!
    Description

    Unique numeral identifier for the image.

  • Name
    title
    Type
    String!
    Description

    The image title.

  • Name
    key
    Type
    String!
    Description

    The image key.

  • Name
    alt
    Type
    String!
    Description

    The image alt.

  • Name
    resource_type
    Type
    String!
    Description

    The image resource type.

  • Name
    overview
    Type
    ImageOverview!
    Description

    The image overview.

  • Name
    updated_at
    Type
    TimeStamp!
    Description

    Timestamp of when the image was updated.

  • Name
    created_at
    Type
    TimeStamp!
    Description

    Timestamp of when the image was created.


Step

Fields

  • Name
    id
    Type
    ID!
    Description

    Unique identifier for the funnel step.

  • Name
    uid
    Type
    ID!
    Description

    Unique identifier for the funnel step.

  • Name
    _id
    Type
    Int!
    Description

    Unique numeral identifier the funnel step.

  • Name
    title
    Type
    String!
    Description

    The funnel step title.

  • Name
    slug
    Type
    String!
    Description

    The funnel step slug.

  • Name
    type
    Type
    StepType!
    Description

    The funnel step type.

    enum StepType {
    	blank_page
    	product_page
    	checkout_page
    	upsell_page
    	downsell_page
    	split_test
    	article_page
    	squeeze_page
    	thank_you_page
    	generic_page
    }
    
  • Name
    funnel_id
    Type
    Int!
    Description

    The funnel id.

  • Name
    fire_lead_insteadof_purchase
    Type
    Boolean
    Description

    Fire lead instead of purchase option.

  • Name
    visual
    Type
    StepVisual!
    Description

    The funnel visual.

    type StepVisual {
    	x: Float!
    	y: Float!
    }
    
  • Name
    settings
    Type
    StepSettings!
    Description

    The funnel settings.

    scalar StepSettings
    
  • Name
    product_id
    Type
    Int
    Description

    The funnel product id.

  • Name
    thumbnail
    Type
    VirtualImage2
    Description

    The funnel thumbnail.

    type VirtualImage2 {
    	key: String
    	url: String
    }
    
  • Name
    body
    Type
    StepBody
    Description

    The funnel step body.

    scalar StepBody
    
  • Name
    disable_token_redirection
    Type
    Boolean!
    Description

    The funnel disable token redirection option.

  • Name
    meta
    Type
    StepMeta
    Description

    The funnel step meta.

    type StepMeta {
    	template: GeniricStepTemplate
    }
    
  • Name
    updated_at
    Type
    TimeStamp!
    Description

    Timestamp of when the image was updated.

  • Name
    created_at
    Type
    TimeStamp!
    Description

    Timestamp of when the image was created.


InputStep

Fields

  • Name
    id
    Type
    ID
    Description

    Unique identifier for the funnel step.

  • Name
    uid
    Type
    ID
    Description

    Unique identifier for the funnel step.

  • Name
    product_id
    Type
    Int
    Description

    The funnel product id.

  • Name
    visual
    Type
    InputStepVisual
    Description

    The funnel visual.

    input InputStepVisual {
    	x: Float
    	y: Float
    }
    
  • Name
    slug
    Type
    String!
    Description

    The funnel step slug.

  • Name
    title
    Type
    String!
    Description

    The funnel step title.

  • Name
    type
    Type
    StepType!
    Description

    The funnel step type.

    enum StepType {
    	blank_page
    	product_page
    	checkout_page
    	upsell_page
    	downsell_page
    	split_test
    	article_page
    	squeeze_page
    	thank_you_page
    	generic_page
    }
    
  • Name
    settings
    Type
    StepSettings!
    Description

    The funnel settings.

    scalar StepSettings
    
  • Name
    body
    Type
    StepBody
    Description

    The funnel step body.

    scalar StepBody
    
  • Name
    disable_token_redirection
    Type
    Boolean
    Description

    The funnel disable token redirection option.

  • Name
    thumbnail
    Type
    String
    Description

    The funnel thumbnail.

  • Name
    template
    Type
    GeniricStepTemplate
    Description

    The funnel template.

    enum GeniricStepTemplate {
    	blank
    	contact_us
    	privacy_policy
    	refund_policy
    	terms_of_service
    }
    
  • Name
    fire_lead_insteadof_purchase
    Type
    Boolean
    Description

    Fire lead instead of purchase option.


FunnelConnection

Fields

  • Name
    pageInfo
    Type
    PageInfo!
    Description

    Funnel connection page info.

    type PageInfo {
    	hasNextPage: Boolean!
    	hasPreviousPage: Boolean!
    	startCursor: String
    	endCursor: String
    }
    
  • Name
    edges
    Type
    [FunnelEdge]
    Description

    The Funnel connection edges.

    type FunnelEdge {
    	node: Funnel
    	cursor: String!
    }
    
  • Name
    count
    Type
    Int!
    Description

    The Funnel connection count.