Conversion Metrics | Yext Hitchhikers Platform

Click Count

Description: The count of all clicks across your online properties. This includes any Search clicks, any Pages clicks (including custom Pages events), and any Listings clicks (including Yelp, Facebook, Google, and the rest of the publisher network).

Request ID & Response ID: CLICK_COUNT

Data Type: Integer

Example Response Value: 12345

Example Response:

{
   "day": "2023-07-26",
   "click_count": 12345
}

Compatible Dimensions:

  • BUSINESS (Required)
  • PARENT_ACCOUNT (Required to make the metric support /all/ in the API)
  • DAYS
  • WEEKS (Dimension only)
  • MONTHS (Dimension only)
  • QUARTERS (Dimension only)
  • DAY_OF_WEEK (Dimension only)
  • WEEK_NUMBER (Week of year) (Dimension only)
  • ENTITIES / ENTITY_IDS / LOCATION_IDS
  • ENTITY_TYPES
  • FOLDERS / FOLDER_IDS
  • LOCATION_LABELS
  • DEVICE_CLASS
  • IS_HUMAN
  • REFERRER_URL

Conversion Count

Description: The count of all conversion events across your online properties. An analytics event must have an associated monetary value (which can be zero) in order for it to be classified as a conversion event.

Request ID & Response ID: CONVERSION_COUNT

Data Type: Integer

Example Response Value: 12345

Example Response:

{
   "day": "2023-07-26",
   "conversion_count": 12345
}

Compatible Dimensions:

  • BUSINESS (Required)
  • PARENT_ACCOUNT (Required to make the metric support /all/ in the API)
  • DAYS
  • WEEKS (Dimension only)
  • MONTHS (Dimension only)
  • QUARTERS (Dimension only)
  • DAY_OF_WEEK (Dimension only)
  • WEEK_NUMBER (Week of year) (Dimension only)
  • ENTITIES / ENTITY_IDS / LOCATION_IDS
  • ENTITY_TYPES
  • FOLDERS / FOLDER_IDS
  • LOCATION_LABELS
  • DEVICE_CLASS
  • IS_HUMAN
  • REFERRER_URL

Total Conversion Value

Description: The total monetary value of your conversions.

Request ID & Response ID: TOTAL_CONVERSION_VALUE

Data Type: Float

Example Response Value: 123.45

Example Response:

{
   "day": "2023-07-26",
   "total_conversion_value": 123.45
}

Compatible Dimensions:

  • BUSINESS (Required)
  • PARENT_ACCOUNT (Required to make the metric support /all/ in the API)
  • DAYS
  • WEEKS (Dimension only)
  • MONTHS (Dimension only)
  • QUARTERS (Dimension only)
  • DAY_OF_WEEK (Dimension only)
  • WEEK_NUMBER (Week of year) (Dimension only)
  • ENTITIES / ENTITY_IDS / LOCATION_IDS
  • ENTITY_TYPES
  • FOLDERS / FOLDER_IDS
  • LOCATION_LABELS
  • DEVICE_CLASS
  • IS_HUMAN
  • REFERRER_URL

Average Conversion Value

Description: The average value of a conversion. This is the total monetary value of your conversions divided by the total number of conversions.

Request ID & Response ID: AVERAGE_CONVERSION_VALUE

Data Type: Float

Example Response Value: 123.45

Example Response:

{
   "day": "2023-07-26",
   "click_count": 123.45
}

Compatible Dimensions:

  • BUSINESS (Required)
  • PARENT_ACCOUNT (Required to make the metric support /all/ in the API)
  • DAYS
  • WEEKS (Dimension only)
  • MONTHS (Dimension only)
  • QUARTERS (Dimension only)
  • DAY_OF_WEEK (Dimension only)
  • WEEK_NUMBER (Week of year) (Dimension only)
  • ENTITIES / ENTITY_IDS / LOCATION_IDS
  • ENTITY_TYPES
  • FOLDERS / FOLDER_IDS
  • LOCATION_LABELS
  • DEVICE_CLASS
  • IS_HUMAN
  • REFERRER_URL
Feedback