Skip to main content

GoalTriggers

Trigger returned within goalDetail, goalCardList, and goalListSummary goals, including soft-deleted triggers.

type GoalTriggers {
  id: Int!
  type: TriggerType!
  name: String
  autoName: String
  codeName: String
  filter: String!
  createdAt: Int!
  deletedAt: Int
  valueType: GoalValueType
  fixedValue: GoalFixedValue
  elementValue: GoalElementValue
}

Fields​

GoalTriggers.id ● Int! non-null scalar​

Trigger id, sent as id in goalEdit triggers; not a goal id.

GoalTriggers.type ● TriggerType! non-null enum​

Trigger kind derived from the filter's criteria; OTHER for mixed or unrecognized criteria.

GoalTriggers.name ● String scalar​

GoalTriggers.autoName ● String scalar​

Fallback trigger label; null when unset.

GoalTriggers.codeName ● String scalar​

Stored code name; the api trigger added for Shopify uses the goal name, others are usually null.

GoalTriggers.filter ● String! non-null scalar​

JSON-encoded trigger filter in the format goalCreate and goalEdit accept.

GoalTriggers.createdAt ● Int! non-null scalar​

Creation time in Unix seconds.

GoalTriggers.deletedAt ● Int scalar​

Soft-deletion time in Unix seconds; null while the trigger is active.

GoalTriggers.valueType ● GoalValueType enum​

Source of the conversion value; null when the trigger has none.

GoalTriggers.fixedValue ● GoalFixedValue object​

Fixed amount settings; null unless valueType is FIXED.

GoalTriggers.elementValue ● GoalElementValue object​

Page element settings; null unless valueType is ELEMENT.

Member Of​

Goal object ● GoalCardGoal object ● GoalSummary object