Insight
Configures an analytics insight.
$idstring Required
The unique identifier for the insight resource.
Must be at least 1 characters long
Must be at most 97 characters long
$schemaconst Required
“https://schema.yext.com/config/analytics/insight/v1" namestring Required
The human-readable name of the insight.
Must be at least 1 characters long
Must be at most 100 characters long
descriptionstring
A description of the insight.
Must be at least 1 characters long
Must be at most 500 characters long
queryobject Required
Configures the query to populate data for the insight.
array of string Required
An array of metric resource identifiers for the metrics to include in the insight.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Each item of this array must be:
array
An array of additional Knowledge Graph fields to include in the data. Fields can only be specified when using the table display option, and when including the yext/entity dimension.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Each item of this array must be:
A field resource identifier.
A derived field identifier.
Must be one of:
- “yext/derivedField-city”
- “yext/derivedField-entityType”
- “yext/derivedField-postalCode”
- “yext/derivedField-state”
array of string Required
An array of dimension resource identifiers for the dimensions to use for the insight.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Each item of this array must be:
array of object
An array of filtering clauses which comprise the filter for the query. Records are returned only when every clause in this list is satisfied. Each clause object must contain the filter property and a single operator property.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Each item of this array must be:
string Required
The filter resource identifier for the filter used in this filter clause.
array of string
For the yext/date filter, this is the start and end dates in YYYY-MM-DD format.
Must contain a minimum of 2 items
Must contain a maximum of 2 items
Each item of this array must be:
An array of values; this filter must equal any one of the values.
Must contain a minimum of 1 items
Each item of this array must be:
For the yext/date filter, the name of a preset date range.
array of string
An array of entity resource identifiers for the yext/entity filter.
Must contain a minimum of 1 items
Each item of this array must be:
array of string
An array of entity-folder resource identifiers for the yext/entityFolder filter.
Must contain a minimum of 1 items
Each item of this array must be:
array of string
An array of entity-label resource identifiers for the yext/entityLabel filter.
Must contain a minimum of 1 items
Each item of this array must be:
array of string
An array of entity-type resource identifiers for the yext/entityType filter.
Must contain a minimum of 1 items
Each item of this array must be:
The period to compare to.
Must be one of:
- “PREVIOUS_PERIOD”
- “PREVIOUS_YEAR”
- “PREVIOUS_FULL_YEAR”
The inclusive interval of dates specifying the period to compare to, with start and end dates in YYYY-MM-DD format.
Must contain a minimum of 2 items
Must contain a maximum of 2 items
Each item of this array must be:
boolean
Whether to normalize values, when the dimension supports it.
display Required
Configures a table.
object Required
object
Configures a sorted table
Required
The column to sort rows by.
string Required
The metric resource name for the metric to sort by.
Required
The field to sort by.
The field resource name for the field to sort by.
A derived field identifier for the field to sort by.
Must be one of:
- “yext/derivedField-city”
- “yext/derivedField-entityType”
- “yext/derivedField-postalCode”
- “yext/derivedField-state”
string Required
The dimension resource name for the dimension to sort by.
Required
string Required
The metric resource name for the metric comparison column to sort by.
object Required
The percent change column
boolean
Whether to sort in descending order instead of ascending order.
boolean
Whether to add columns to show ranking.
Number of rows to display.
Value must be greater or equal to 1 and lesser or equal to 1000
“FIT_TO_HEIGHT” boolean
Whether to show the grand total row for the insight at the end of the table.
object
Configures sparklines for the table.
array of string Required
The metric resource names for the metrics to display sparklines for
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Each item of this array must be:
Configures a line chart.
object Required
boolean
Whether the line chart should color the area beneath the lines.
boolean
Whether the line chart should have independent axes.
boolean
Whether data labels should be displayed.
object
boolean
Whether line hero numbers should be displayed.
Configures a bar chart.
object Required
enum (of string)
The style of bar chart.
Must be one of:
- “NORMAL”
- “STACKED”
- “PERCENT”
boolean
Whether the bar chart should be oriented horizontally; if false, bars will be oriented vertically.
boolean
Whether data labels should be displayed.
Configures a pie chart.
object Required
enum (of string)
Must be one of:
- “SOLID”
- “DOUGHNUT”
boolean
Whether data labels should be displayed.
Reserved; must not be present.
object Required
Configures a hero number.
object Required
enum (of string) Required
Must be one of:
- “SUM”
- “MEAN”
Configures a map.
object Required
enum (of string)
Configures the scale of the map’s color bar.
Must be one of:
- “LINEAR”
- “LOGARITHMIC”
visibilityobject
Reserved; must not be present.