Reviews Metrics and Dimensions | Yext Hitchhikers Platform

Reviews Metrics

Average Rating

Description: The cumulative average of the ratings your business has received.

Request ID: AVERAGE_RATING

Response ID: Average Rating

Data Type: Float

Example Response Value: 0

Example Response: {"Average Rating": 0.0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
  • REVIEW_TRENDS
• API Only
  • ACCOUNT_IDS

Keyword Mentions

Description: The number of times a review keyword is mentioned.

Request ID: KEYWORD_MENTIONS

Response ID: Keyword Mentions

Data Type: Integer

Example Response Value: 0

Example Response: {"day": "1980-01-01", "Keyword Mentions": 0}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
  • REVIEW_TRENDS
• API Only
  • ACCOUNT_IDS

Keyword Sentiment

Description: The sentiment score of review keywords.

Request ID: KEYWORD_SENTIMENT

Response ID: Keyword Sentiment

Data Type: Float

Example Response Value: 0

Example Response: {"Keyword Sentiment": 0.0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
  • REVIEW_TRENDS
• API Only
  • ACCOUNT_IDS

Response Count

Description: The number of reviews with responses on publishers that support in-platform response.

Request ID: RESPONSE_COUNT

Response ID: Response Count

Data Type: Integer

Example Response Value: 0

Example Response: {"Response Count": 0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
  • REVIEW_TRENDS
• API Only
  • ACCOUNT_IDS

Response Rate

Description: The percentage of reviews with responses on publishers that support in-platform response.

Request ID: RESPONSE_RATE

Response ID: Response Rate

Data Type: Integer

Example Response Value: 0

Example Response: {"Response Rate": 0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
• API Only
  • ACCOUNT_IDS

Response Time (Hours)

Description: The average time in hours between the review date and the response date of all reviews with responses that can be responded to in the platform.

Request ID: RESPONSE_TIME

Response ID: Response Time (Hours)

Data Type: Float

Example Response Value: 0

Example Response: {"Response Time (Hours)": 0.0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
• API Only
  • ACCOUNT_IDS

Reviews

Description: The number of new reviews your business has received.

Request ID: NEW_REVIEWS

Response ID: Reviews

Data Type: Integer

Example Response Value: 0

Example Response: {"New Reviews": 0, "day": "1980-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEK_NUMBER
  • WEEKS
• Entities
  • ENTITY_IDS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
• Reviews
  • AWAITING_RESPONSE
  • GENERATION_SOURCE
  • REVIEW_PUBLISHER_TYPE
  • RATINGS
  • RESPONSE_TIME
  • REVIEW_KEYWORDS
  • REVIEW_LABELS
  • REVIEW_STATUS
  • SENTIMENT_COLLECTION
  • PARTNERS
  • REVIEW_TRENDS
• API Only
  • ACCOUNT_IDS

Reviews Theme Average Rating

Description: The average review of all the reviews in the theme.

Request ID: CLUSTER_AVERAGE_RATING

Response ID: CLUSTER_AVERAGE_RATING

Data Type: Float

Example Response Value: 3.98

Example Response: {"CLUSTER_AVERAGE_RATING": 3.98, "DAY_OF_WEEK": "Friday"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEKS
• Entities
  • ENTITY_IDS
• API Only
  • ACCOUNT_IDS

Reviews Theme Reviews

Description: The total number of reviews in the theme.

Request ID: CLUSTER_REVIEW_COUNT

Response ID: CLUSTER_REVIEW_COUNT

Data Type: Integer

Example Response Value: 124

Example Response: {"CLUSTER_REVIEW_COUNT": 124, "MONTHS": "2025-01-01"}

Compatible Dimensions:

• Time
  • DAY_OF_WEEK
  • DAYS
  • MONTHS
  • QUARTERS
  • WEEKS
• Entities
  • ENTITY_IDS
• API Only
  • ACCOUNT_IDS

Rolling Average Rating

Description: Average review rating of your entities as well as your competitors entities. This metric is available for accounts with Competitive Intelligence.

Request ID: CUMULATIVE_RATING

Response ID: Rolling Average Rating

Data Type: Float

Example Response Value: 3.98

Example Response: {"Rolling Average Rating": 3.98, "competitor": "Ali Baba"}

Compatible Dimensions:

• Time
  • MONTHS
• Entities
  • ENTITY_IDS
  • ENTITY_GROUPS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
  • ZIP_CODE
• Reviews
  • PARTNERS
• API Only
  • ACCOUNT_IDS

Rolling Review Volume

Description: Cumulative review volume of your entities as well as your competitors entities.Competitor data is based on the most recent Competitive Intelligence scan before your selected date range. Your entity data includes all reviews within your selected date range. This metric is available for accounts with Competitive Intelligence.

Request ID: CUMULATIVE_REVIEW_VOLUME

Response ID: Rolling Review Volume

Data Type: Integer

Example Response Value: 124

Example Response: {"Rolling Review Volume": 124, "competitor": "Ali Baba"}

Compatible Dimensions:

• Time
  • MONTHS
• Entities
  • ENTITY_IDS
  • ENTITY_GROUPS
  • ENTITY_TYPES
  • FOLDER_NAMES
  • LOCATION_NAMES
  • ZIP_CODE
• Reviews
  • PARTNERS
• API Only
  • ACCOUNT_IDS

Reviews Dimensions

Awaiting Response

Description: Identify reviews by whether they have a response or not.

Request ID: AWAITING_RESPONSE

Response ID: AWAITING_RESPONSE

Data Type: Boolean

Example Response Value: FALSE

Example Response: {"Reviews": 124, "AWAITING_RESPONSE": "FALSE"}

Generation Source

Description: Identify reviews by their generation source

Request ID: GENERATION_SOURCE

Response ID: GENERATION_SOURCE

Data Type: enum: ["SMS", "QR Code", "Organic", "Email", or "Direct Link"]

Example Response Value: QR Code

Example Response: {"Reviews": 124, "GENERATION_SOURCE": "QR Code"}

Publisher Type

Description: Identify reviews by their publisher type, first-party or third-party.

Request ID: REVIEW_PUBLISHER_TYPE

Response ID: REVIEW_PUBLISHER_TYPE

Data Type: enum: ["First-party", "Third-party"]

Example Response Value: First-party

Example Response: {"Reviews": 124, "REVIEW_PUBLISHER_TYPE": "First-party"}

Ratings

Description: Identify reviews by their star ratings.

Request ID: RATINGS

Response ID: RATINGS

Data Type: String

Example Response Value: enum: ["0", "1", "2", "3", "4", "5"]

Example Response: {"Reviews": 124, "RATINGS": "4"}

Response Time

Description: Identify reviews by how long it took to respond to them.

Request ID: RESPONSE_TIME

Response ID: RESPONSE_TIME

Data Type: enum: ["LESS_THAN_HOUR", "BETWEEN_HOUR_DAY", "BETWEEN_DAY_WEEK", "BETWEEN_WEEK_MONTH", "GREATER_THAN_MONTH"]

Example Response Value: BETWEEN_WEEK_MONTH

Example Response: {"Reviews": 124, "RESPONSE_TIME": "BETWEEN_WEEK_MONTH"}

Review Keywords

Description: Identify reviews by the keywords used.

Request ID: REVIEW_KEYWORDS

Response ID: REVIEW_KEYWORDS

Data Type: String

Example Response Value: “Service”

Example Response: {"Reviews": 124, "REVIEW_KEYWORDS": "Service"}

Review Labels

Description: Identify reviews by their label.

Request ID: REVIEW_LABELS

Response ID: REVIEW_LABELS

Data Type: String

Example Response Value: “Appetizers”

Example Response: {"Reviews": 124, "REVIEW_LABELS": "Appetizers"}

Review Status

Description: Identify reviews by their status.

Request ID: REVIEW_STATUS

Response ID: REVIEW_STATUS

Data Type: enum: ["Live", "Quarantined", "Removed"]

Example Response Value: Live

Example Response: {"Reviews": 124, "REVIEW_STATUS": "Live"}

Sentiment Collection

Description: Identify reviews by their sentiment collection of keywords. The response value is formatted as “[ID] - [Name]” of the sentiment collection.

Request ID: SENTIMENT_COLLECTION

Response ID: SENTIMENT_COLLECTION

Data Type: String

Example Response Value: “3 - Food”

Example Response: {"Reviews": 124, "SENTIMENT_COLLECTION": "3 - Food"}

Sites

Description: Sites, apps, or integrations in the Publisher network.

Request ID: PARTNERS

Response ID: PARTNERS

Data Type: String

Example Response Value: “Facebook”

Example Response: {"Reviews": 124, "PARTNERS": "Facebook"}

Summary

Description: Identify reviews by their summary.

Request ID: REVIEW_TRENDS

Response ID: REVIEW_TRENDS

Data Type: String

Example Response Value: “[Jun 01 - Jun 30] - Appointment dissatisfaction”

Example Response: {"Reviews": 124, "REVIEW_TRENDS": "[Jun 01 - Jun 30] - Appointment dissatisfaction"}