Yext · Schema
Yext Entity
A discrete record in the Yext Knowledge Graph representing a business object such as a location, event, FAQ, product, or custom type.
Digital PresenceBusiness ListingsLocation DataReviewsAI SearchKnowledge Graph
Properties
| Name | Type | Description |
|---|---|---|
| data | object | The data containing the main content of the entity. The format of the data is dependent on the entity type. |
| highlightedFields | object | A map from fieldId to highlighted element, used in search results to mark query match snippets. |
| distance | integer | The distance in meters between the entity and the query location bias. |
| distanceFromFilter | integer | The distance in meters between the entity and the nearest filter location. |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/yext/main/json-schema/yext-entity-schema.json",
"title": "Yext Entity",
"description": "A discrete record in the Yext Knowledge Graph representing a business object such as a location, event, FAQ, product, or custom type.",
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The data containing the main content of the entity. The format of the data is dependent on the entity type.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for this entity within the account."
},
"name": {
"type": "string",
"description": "The name of the entity."
},
"type": {
"type": "string",
"description": "The entity type identifier (e.g., location, restaurant, healthcareProfessional)."
}
}
},
"highlightedFields": {
"type": "object",
"description": "A map from fieldId to highlighted element, used in search results to mark query match snippets."
},
"distance": {
"type": "integer",
"description": "The distance in meters between the entity and the query location bias."
},
"distanceFromFilter": {
"type": "integer",
"description": "The distance in meters between the entity and the nearest filter location."
}
}
}