Skip to main content

funnelCreate

Creates a saved funnel definition; use funnelResult to calculate its metrics without changing the definition. Every goal must be accessible and belong to siteId; visitStep prepends a synthetic visit baseline. Returns the saved funnel with goals in supplied order. Requires funnels edit access.

funnelCreate(
  siteId: Int!
  name: String!
  visitStep: Boolean!
  goalSteps: [Int]!
): Funnel!

Arguments​

funnelCreate.siteId ● Int! non-null scalar​

Site ID from sites; all goalSteps goals must belong to it.

funnelCreate.name ● String! non-null scalar​

Nonblank funnel display name.

funnelCreate.visitStep ● Boolean! non-null scalar​

True to prepend a site-wide visit baseline before the ordered goal steps.

funnelCreate.goalSteps ● [Int]! non-null scalar​

Ordered goal IDs from goalRefList, all accessible and belonging to siteId; matching uses the goals' configured triggers.

Type​

Funnel object​

Saved funnel definition returned by funnel list, detail, create, and edit operations. Use its ordered goals and optional visit baseline with funnelResult.