Conversion Action

Configures a Conversion Action.

$idstring Required

The unique identifier for the Conversion Action resource.

$schemaconst Required

Specific value: "https://schema.yext.com/config/analytics/conversion-action/v2"

conversionNamestring Required

The human-readable name of the Conversion.

conversionTypeenum (of string) Required

The type of event that the Conversion represents.

Must be one of:

  • “PURCHASE”
  • “LEAD”
  • “PAGE_VIEW”
  • “SIGN_UP”
  • “OTHER”
  • “COST_SAVING_CUSTOMER_SUPPORT”
  • “COST_SAVING_OTHER”

conversionValueTypeenum (of string) Required

The way a value is applied to the Conversion, e.g. the same value for each Conversion, or no value used. The DIFFERENT value is only valid without defined ‘clickTriggers’.

Must be one of:

  • “SAME”
  • “NONE”
  • “DIFFERENT”

conversionValueAmountnumber Required

The value of the the Conversion, set to the currency of the primary country associated with the Yext account. If there is no associated value, set to 0.

conversionTermobject

Include all Conversions within the specified time frame. Enter just startDate to include only Conversions on or after this date. Enter just endDate to include only Conversions before this date. Enter both a startDate and endDate to include only Conversions between these dates. If no conversionTerm is provided, defaults startDate to the current UTC date.

string

The inclusive start date of the Conversion term, in YYYY-mm-dd format

string

The exclusive end date of the Conversion term, in YYYY-mm-dd format

conversionTrigger Required

Type: object

Click-based Conversion Triggers let you automatically treat certain clicks as Conversions. For example, you can say that any Driving Direction click should be counted as a Conversion. Click-based Conversion Triggers do not require the use of JavaScript tags and work with all Yext products.

array of object Required

Defines which types of clicks are counted as a Conversion.

Must contain a minimum of 1 items

Each item of this array must be:

Type: object

enum (of string) Required

The type of click that should be counted as a Conversion.

Must be one of:

  • “CALL”
  • “DETAIL”
  • “DRIVING_DIRECTIONS”
  • “FEATURED_MESSAGE”
  • “UBER_LINK”
  • “WEB”
  • “OTHER_CLICK_TYPE”
  • “ALL_CLICK_TYPES”
  • “CALL_TO_ACTION”
  • “ORDER_NOW”
  • “TITLE”
  • “ADD_TO_CART”
  • “APPLY_NOW”
  • “THUMBS_UP”
  • “ROW_EXPAND”
  • “EMAIL”
  • “BOOK_APPOINTMENT”
  • “RSVP”

array Required

The media source(s) of clicks to consider when counting Conversions.

Must contain a minimum of 1 items

Each item of this array must be:

Type: object

The general Yext product type to source clicks from when counting Conversions.

enum (of string)

Must be one of:

  • “ALL_LISTINGS_PUBLISHERS”
  • “ALL_ANSWERS_EXPERIENCES”
  • “ALL_SEARCH_ENGINES”
  • “ALL_PAGES_LOCATOR_OR_DIRECTORY”
  • “ALL_FIRST_PARTY_SITES”
  • “ALL_PAGES_LANDING_PAGE_SETS”
  • “ALL_REFERRAL_SITES”
  • “ALL_WIDGETS”
  • “ALL_MEDIUM_TYPES”
Type: object

The specific Answers configuration to source clicks from when counting Conversions.

string

object

The entities whose clicks should be counted as Conversions.

array of string

An array of ‘km/entity-type’ resource identifiers to filter Conversions by.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of ‘km/entity’ resource identifiers to filter Conversions by.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of ‘km/entity-label’ resource identifiers to filter Conversions by.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of ‘km/entity-folder’ resource identifiers to filter Conversions by.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

number Required

Specifies the percentage of events that should count as Conversions.

Value must be greater or equal to 1 and lesser or equal to 100

Type: object

Tag Conversion Triggers let you control where the conversion is triggered when you install a conversion tracking tag on the page where the conversion occurs. After creating the conversion action, the conversion tracking tag and instructions to install can be found on the Conversion Tracking Setup page.

enum (of string) Required

Specifies how many conversions to count per click or interaction.

Must be one of:

  • “EVERY”
  • “ONE”

number Required

Specifies the maximum number of days after a page interaction that a conversion will be counted.

Value must be greater or equal to 1 and lesser or equal to 90

enum (of string) Required

Determines how much credit each interaction gets for a conversion.

Must be one of:

  • “LINEAR”
  • “LAST_CLICK”
  • “FIRST_CLICK”

enabledboolean Required

Whether or not the Conversion resource should be considered active. Conversions will not be counted for disabled Conversion resources.