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
- ID
- 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
share_code- Type
- String
- Description
The funnel share code.
- Name
styles- Type
- [StepStyle!]
- Description
The funnel styles.
input StepStyle { 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
updated_at- Label
TimeStamp!- Description
Timestamp of when the funnel was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the funnel was created.
- Name
template- Label
Template- Description
Funnel template.
- Name
destinationTemplate- Label
Template- Description
Funnel destination template.
- Name
preferred_domain- Label
Domain- Description
The funnel preferred domain.
- Name
preferred_domain_id- Type
- ID
- Description
The funnel preferred domain id.
- Name
favicon- Label
Image- Description
The funnel favicon.
- Name
favicon_id- Type
- ID
- Description
The funnel favicon id.
- Name
default_language- Type
- FunnelLanguage!
- Description
The funnel default language.
scalar FunnelLanguage
- Name
languages- Type
- [FunnelLanguage!]!
- Description
The funnel languages.
scalar FunnelLanguage
- Name
steps- Label
[Step!]!- Description
The funnel steps.
- Name
statistics- Label
FunnelStatistics!- Description
The funnel statistics.
# Arguments startDate: String endDate: String
- Name
header_scripts- Type
- String
- Description
The funnel header scripts.
- Name
ignore_invalide_phones- Type
- Boolean!
- Description
The funnel ignore invalid phones option.
- Name
store- Label
Store- Description
The funnel store.
- Name
currency- Type
- String
- Description
The funnel currency.
- Name
currency_format- Type
- String
- Description
The funnel currency format.
- Name
smart_sections- Type
- [SmartSection!]!
- Description
The funnel smart sections.
type SmartSection { reference_id: ID! name: String! thumbnail: VirtualImage2! body: BuilderNode! }type VirtualImage2 { key: String url: String } scalar BuilderNode
Request
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
funnel_steps- Label
[StepType!]!- Description
The funnel steps.
- Name
style_id- Type
- ID
- Description
The funnel style id.
- Name
product_id- Type
- ID
- Description
The funnel product id.
- Name
name- Type
- String!
- Description
The funnel name.
- Name
slug- Type
- String!
- Description
The funnel slug.
- Name
currency- Type
- String
- Description
The funnel currency.
- Name
lang- Type
- FunnelLanguage!
- Description
The funnel language.
scalar FunnelLanguage
Request
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_uid- Type
- ID
- Description
The funnel starting step uid.
- Name
favicon_id- Type
- ID
- Description
The funnel favicon id.
- Name
steps- Label
[InputUpdateStep!]- Description
The funnel steps.
- Name
deleted_steps- Type
- [ID!]
- 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_methods- 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
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.
scalar FunnelLanguage
- Name
languages- Type
- [FunnelLanguage!]
- Description
The funnel languages.
scalar FunnelLanguage
- Name
ignore_invalide_phones- Type
- Boolean
- Description
The funnel ignore invalid phones option.
- Name
currency- Type
- String
- Description
The funnel currency.
- Name
currency_format- Type
- String
- Description
The funnel currency format.
- Name
smart_sections- Type
- [SmartSectionInput!]
- Description
The funnel smart sections.
type SmartSectionInput { reference_id: ID! name: String! thumbnail: VirtualImage2! body: BuilderNode! }type VirtualImage2 { key: String url: String } scalar BuilderNode
- Name
reset_translations- Type
- Boolean
- Description
The funnel reset translations boolean.
Request
mutation updateFunnelMutation($node: InputFunnel!, $id: Int!){
updateFunnel(node: $node, id: $id){
# Funnel type fields
}
}
InputUpdateStep
Fields
- Name
id- Type
- ID!
- Description
The funnel unique identifier.
- Name
product_uid- Type
- ID!
- Description
The funnel product uid.
- Name
slug- Type
- String!
- Description
The funnel slug.
- Name
visual- Type
- InputStepVisual
- Description
The funnel visual.
input InputStepVisual { x: Float y: Float }
- Name
title- Type
- String!
- Description
The funnel title.
- Name
type- Label
StepType!- Description
The funnel step type.
FunnelPaymentGateway
Fields
- Name
index- Type
- Int!
- Description
The funnel index.
- Name
payment_gateway_id- Type
- ID!
- 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
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
slug- Type
- String!
- Description
The funnel step slug.
- Name
title- Type
- String!
- Description
The funnel step title.
- Name
type- Label
StepType!- Description
The funnel step type.
- Name
visual- Type
- StepVisual!
- Description
The funnel step visual.
type StepVisual { x: Float! y: Float! }
- Name
settings- Type
- StepSettings!
- Description
The funnel step settings.
scalar StepSettings
- Name
product_id- Type
- ID
- Description
The funnel step product id.
- Name
funnel- Type
- Funnel
- Description
The funnel type.
- Name
thumbnail- Type
- VirtualImage2
- Description
The funnel step thumbnail.
- Name
body- Type
- StepBody
- Description
The funnel step body.
- Name
links- Type
- [StepLink!]
- Description
The funnel step links.
- Name
disable_token_redirection- Type
- Boolean!
- Description
The funnel step disable token redirection.
- Name
meta- Type
- StepMeta!
- Description
The funnel step disable token redirection.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the image was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the image was created.
InputStep
Fields
- Name
product_id- Type
- ID
- Description
The funnel product id.
- Name
slug- Type
- String!
- Description
The funnel step slug.
- Name
visual- Type
- InputStepVisual
- Description
The funnel visual.
input InputStepVisual { x: Float y: Float }
- Name
title- Type
- String!
- Description
The funnel step title.
- Name
type- Label
StepType!- Description
The funnel step type.
- Name
settings- Type
- StepSettings!
- Description
The funnel step 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 }
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.
StepType
enum StepType {
blank_page
product_page
checkout_page
upsell_page
downsell_page
split_test
article_page
squeeze_page
thank_you_page
generic_page
home_page
collection_page
}
FunnelStatistics
- Name
steps- Label
[StepStatistics!]!- Description
Funnel statistics steps
StepStatistics
- Name
id- Type
- String!
- Description
Unique identifier for the funnel step statistics.
- Name
visits- Type
- Int!
- Description
Funnel visits
- Name
clicks- Type
- Int!
- Description
Funnel clicks
- Name
ctr- Type
- Float!
- Description
Funnel click through rate
- Name
links- Label
[StepLinkState!]!- Description
Funnel step links
StepLinkState
- Name
id- Type
- String!
- Description
Unique identifier for the funnel step link state.
- Name
visits- Type
- Int!
- Description
Funnel visits
- Name
ctr- Type
- Float!
- Description
Funnel click through rate
- Name
cvr- Type
- Float!
- Description
Funnel conversion rate
Template
- Name
id- Type
- ID!
- Description
Unique identifier for the funnel template.
- Name
uid- Type
- ID!
- Description
Unique identifier for the funnel template.
- Name
_id- Type
- Int!
- Description
Unique numeral identifier for the funnel template.
- Name
name- Type
- String!
- Description
Funnel template name
- Name
thumbnail- Type
- String!
- Description
Funnel template thumbnail
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the funnel template was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the funnel template was created.
- Name
pages- Label
[TemplatePage!]!- Description
Funnel template pages
- Name
mobile_thumbnail- Type
- String!
- Description
Funnel template mobile thumbnail
- Name
desktop_thumbnail- Type
- String!
- Description
Funnel template desktop thumbnail
- Name
price- Type
- Float!
- Description
Funnel template price
- Name
description- Type
- String!
- Description
Funnel template description
- Name
tags- Type
- [String!]!
- Description
Funnel template tags
- Name
features- Type
- [Feature!]!
- Description
Funnel template features
type Feature { id: ID! image: String! title: String! description: String! }
- Name
likes- Type
- Int!
- Description
Funnel template likes
- Name
isLiked- Type
- Boolean
- Description
Funnel template isLiked boolean
- Name
languages- Type
- [FunnelLanguage!]!
- Description
Funnel template languages
scalar FunnelLanguage
TemplatePage
- Name
id- Type
- ID!
- Description
Unique identifier for the funnel template page.
- Name
_id- Type
- Int!
- Description
Unique numeral identifier for the funnel template page.
- Name
url- Type
- String!
- Description
Funnel template page url
- Name
name- Type
- String!
- Description
Funnel template page name
- Name
type- Type
- StepType!
- Description
Funnel template page type
enum StepType { blank_page product_page checkout_page upsell_page downsell_page split_test article_page squeeze_page thank_you_page generic_page home_page collection_page }