Conversion Tracking Metrics | Yext Hitchhikers Platform
Click Count
Description: The count of all clicks across your online properties.
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.
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
Clicks (Legacy)
Description: The number of times consumers clicked on your online properties.
Request ID & Response ID: CLICKS
Data Type: Integer
Example Response Value: 13040
Example Response: {"day": "2022-01-10", "CLICKS": 13040}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Conversion Rate (Legacy)
Description: Conversions divided by clicks.
Request ID & Response ID: CONVERSION_RATE
Data Type: Float
Example Response Value: 0.01
Example Response: {"CONVERSION_RATE": 0.01, "day": "2022-01-10"}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Conversion Searches (Legacy)
Description: The number of Answers Searches with a Click.
Request ID & Response ID: CONVERSION_SEARCHES
Data Type: Integer
Example Response Value: 466
Example Response: {"CONVERSION_SEARCHES": 466, "day": "2022-01-12"}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Conversion Sessions (Legacy)
Description: The number of Answers Sessions with a Click.
Request ID & Response ID: SESSIONS
Data Type: Integer
Example Response Value: 373
Example Response: {"SESSIONS": 373, "day": "2022-01-12"}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Conversion Value (Legacy)
Description: The monetary impact of your conversions.
Request ID & Response ID: CONVERSION_VALUE
Data Type: Float
Example Response Value: 4
Example Response: {"CONVERSION_VALUE": 4.0, "day": "2022-01-10"}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Conversions (Legacy)
Description: The number of conversions based on the methodology you selected.
Request ID & Response ID: CONVERSIONS
Data Type: Float
Example Response Value: 152
Example Response: {"day": "2022-01-10", "CONVERSIONS": 152.0}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY
Value per Conversion (Legacy)
Description: Total conversion value divided by the number of conversions.
Request ID & Response ID: VALUE_PER_CONVERSION
Data Type: Float
Example Response Value: 0.03
Example Response: {"VALUE_PER_CONVERSION": 0.03, "day": "2022-01-10"}
Compatible Dimensions:
- ANSWERS_VERSION_LABEL
- CLICK_TYPE
- WEEKS
- ACCOUNT_IDS
- FOLDER_NAMES
- MONTHS_RETAIL
- SEARCH_QUERY